Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. containerservice
  5. getFleet
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.containerservice.getFleet

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets a Fleet.

    Uses Azure REST API version 2024-05-02-preview.

    Other available API versions: 2022-06-02-preview, 2022-07-02-preview, 2022-09-02-preview, 2023-03-15-preview, 2023-06-15-preview, 2023-08-15-preview, 2023-10-15, 2024-02-02-preview, 2024-04-01, 2025-03-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native containerservice [ApiVersion]. See the version guide for details.

    Using getFleet

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getFleet(args: GetFleetArgs, opts?: InvokeOptions): Promise<GetFleetResult>
function getFleetOutput(args: GetFleetOutputArgs, opts?: InvokeOptions): Output<GetFleetResult>
    def get_fleet(fleet_name: Optional[str] = None,
              resource_group_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetFleetResult
def get_fleet_output(fleet_name: Optional[pulumi.Input[str]] = None,
              resource_group_name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetFleetResult]
    func LookupFleet(ctx *Context, args *LookupFleetArgs, opts ...InvokeOption) (*LookupFleetResult, error)
func LookupFleetOutput(ctx *Context, args *LookupFleetOutputArgs, opts ...InvokeOption) LookupFleetResultOutput

    > Note: This function is named LookupFleet in the Go SDK.

    public static class GetFleet 
{
    public static Task<GetFleetResult> InvokeAsync(GetFleetArgs args, InvokeOptions? opts = null)
    public static Output<GetFleetResult> Invoke(GetFleetInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetFleetResult> getFleet(GetFleetArgs args, InvokeOptions options)
public static Output<GetFleetResult> getFleet(GetFleetArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:containerservice:getFleet
  arguments:
    # arguments dictionary

    The following arguments are supported:

    FleetName string
    The name of the Fleet resource.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    FleetName string
    The name of the Fleet resource.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    fleetName String
    The name of the Fleet resource.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    fleetName string
    The name of the Fleet resource.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    fleet_name str
    The name of the Fleet resource.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    fleetName String
    The name of the Fleet resource.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getFleet Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    ETag string
    If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    The status of the last operation.
    SystemData Pulumi.AzureNative.ContainerService.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    HubProfile Pulumi.AzureNative.ContainerService.Outputs.FleetHubProfileResponse
    The FleetHubProfile configures the Fleet's hub.
    Identity Pulumi.AzureNative.ContainerService.Outputs.ManagedServiceIdentityResponse
    Managed identity.
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    ETag string
    If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    The status of the last operation.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    HubProfile FleetHubProfileResponse
    The FleetHubProfile configures the Fleet's hub.
    Identity ManagedServiceIdentityResponse
    Managed identity.
    Tags map[string]string
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    eTag String
    If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    The status of the last operation.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    hubProfile FleetHubProfileResponse
    The FleetHubProfile configures the Fleet's hub.
    identity ManagedServiceIdentityResponse
    Managed identity.
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    eTag string
    If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    provisioningState string
    The status of the last operation.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    hubProfile FleetHubProfileResponse
    The FleetHubProfile configures the Fleet's hub.
    identity ManagedServiceIdentityResponse
    Managed identity.
    tags {[key: string]: string}
    Resource tags.
    azure_api_version str
    The Azure API version of the resource.
    e_tag str
    If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    provisioning_state str
    The status of the last operation.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    hub_profile FleetHubProfileResponse
    The FleetHubProfile configures the Fleet's hub.
    identity ManagedServiceIdentityResponse
    Managed identity.
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    eTag String
    If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    The status of the last operation.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    hubProfile Property Map
    The FleetHubProfile configures the Fleet's hub.
    identity Property Map
    Managed identity.
    tags Map<String>
    Resource tags.

    Supporting Types

    APIServerAccessProfileResponse

    EnablePrivateCluster bool
    Whether to create the Fleet hub as a private cluster or not.
    EnableVnetIntegration bool
    Whether to enable apiserver vnet integration for the Fleet hub or not.
    SubnetId string
    The subnet to be used when apiserver vnet integration is enabled. It is required when creating a new Fleet with BYO vnet.
    EnablePrivateCluster bool
    Whether to create the Fleet hub as a private cluster or not.
    EnableVnetIntegration bool
    Whether to enable apiserver vnet integration for the Fleet hub or not.
    SubnetId string
    The subnet to be used when apiserver vnet integration is enabled. It is required when creating a new Fleet with BYO vnet.
    enablePrivateCluster Boolean
    Whether to create the Fleet hub as a private cluster or not.
    enableVnetIntegration Boolean
    Whether to enable apiserver vnet integration for the Fleet hub or not.
    subnetId String
    The subnet to be used when apiserver vnet integration is enabled. It is required when creating a new Fleet with BYO vnet.
    enablePrivateCluster boolean
    Whether to create the Fleet hub as a private cluster or not.
    enableVnetIntegration boolean
    Whether to enable apiserver vnet integration for the Fleet hub or not.
    subnetId string
    The subnet to be used when apiserver vnet integration is enabled. It is required when creating a new Fleet with BYO vnet.
    enable_private_cluster bool
    Whether to create the Fleet hub as a private cluster or not.
    enable_vnet_integration bool
    Whether to enable apiserver vnet integration for the Fleet hub or not.
    subnet_id str
    The subnet to be used when apiserver vnet integration is enabled. It is required when creating a new Fleet with BYO vnet.
    enablePrivateCluster Boolean
    Whether to create the Fleet hub as a private cluster or not.
    enableVnetIntegration Boolean
    Whether to enable apiserver vnet integration for the Fleet hub or not.
    subnetId String
    The subnet to be used when apiserver vnet integration is enabled. It is required when creating a new Fleet with BYO vnet.

    AgentProfileResponse

    SubnetId string
    The ID of the subnet which the Fleet hub node will join on startup. If this is not specified, a vnet and subnet will be generated and used.
    VmSize string
    The virtual machine size of the Fleet hub.
    SubnetId string
    The ID of the subnet which the Fleet hub node will join on startup. If this is not specified, a vnet and subnet will be generated and used.
    VmSize string
    The virtual machine size of the Fleet hub.
    subnetId String
    The ID of the subnet which the Fleet hub node will join on startup. If this is not specified, a vnet and subnet will be generated and used.
    vmSize String
    The virtual machine size of the Fleet hub.
    subnetId string
    The ID of the subnet which the Fleet hub node will join on startup. If this is not specified, a vnet and subnet will be generated and used.
    vmSize string
    The virtual machine size of the Fleet hub.
    subnet_id str
    The ID of the subnet which the Fleet hub node will join on startup. If this is not specified, a vnet and subnet will be generated and used.
    vm_size str
    The virtual machine size of the Fleet hub.
    subnetId String
    The ID of the subnet which the Fleet hub node will join on startup. If this is not specified, a vnet and subnet will be generated and used.
    vmSize String
    The virtual machine size of the Fleet hub.

    FleetHubProfileResponse

    Fqdn string
    The FQDN of the Fleet hub.
    KubernetesVersion string
    The Kubernetes version of the Fleet hub.
    PortalFqdn string
    The Azure Portal FQDN of the Fleet hub.
    AgentProfile Pulumi.AzureNative.ContainerService.Inputs.AgentProfileResponse
    The agent profile for the Fleet hub.
    ApiServerAccessProfile Pulumi.AzureNative.ContainerService.Inputs.APIServerAccessProfileResponse
    The access profile for the Fleet hub API server.
    DnsPrefix string
    DNS prefix used to create the FQDN for the Fleet hub.
    Fqdn string
    The FQDN of the Fleet hub.
    KubernetesVersion string
    The Kubernetes version of the Fleet hub.
    PortalFqdn string
    The Azure Portal FQDN of the Fleet hub.
    AgentProfile AgentProfileResponse
    The agent profile for the Fleet hub.
    ApiServerAccessProfile APIServerAccessProfileResponse
    The access profile for the Fleet hub API server.
    DnsPrefix string
    DNS prefix used to create the FQDN for the Fleet hub.
    fqdn String
    The FQDN of the Fleet hub.
    kubernetesVersion String
    The Kubernetes version of the Fleet hub.
    portalFqdn String
    The Azure Portal FQDN of the Fleet hub.
    agentProfile AgentProfileResponse
    The agent profile for the Fleet hub.
    apiServerAccessProfile APIServerAccessProfileResponse
    The access profile for the Fleet hub API server.
    dnsPrefix String
    DNS prefix used to create the FQDN for the Fleet hub.
    fqdn string
    The FQDN of the Fleet hub.
    kubernetesVersion string
    The Kubernetes version of the Fleet hub.
    portalFqdn string
    The Azure Portal FQDN of the Fleet hub.
    agentProfile AgentProfileResponse
    The agent profile for the Fleet hub.
    apiServerAccessProfile APIServerAccessProfileResponse
    The access profile for the Fleet hub API server.
    dnsPrefix string
    DNS prefix used to create the FQDN for the Fleet hub.
    fqdn str
    The FQDN of the Fleet hub.
    kubernetes_version str
    The Kubernetes version of the Fleet hub.
    portal_fqdn str
    The Azure Portal FQDN of the Fleet hub.
    agent_profile AgentProfileResponse
    The agent profile for the Fleet hub.
    api_server_access_profile APIServerAccessProfileResponse
    The access profile for the Fleet hub API server.
    dns_prefix str
    DNS prefix used to create the FQDN for the Fleet hub.
    fqdn String
    The FQDN of the Fleet hub.
    kubernetesVersion String
    The Kubernetes version of the Fleet hub.
    portalFqdn String
    The Azure Portal FQDN of the Fleet hub.
    agentProfile Property Map
    The agent profile for the Fleet hub.
    apiServerAccessProfile Property Map
    The access profile for the Fleet hub API server.
    dnsPrefix String
    DNS prefix used to create the FQDN for the Fleet hub.

    ManagedServiceIdentityResponse

    PrincipalId string
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    TenantId string
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    Type string
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.ContainerService.Inputs.UserAssignedIdentityResponse>
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    PrincipalId string
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    TenantId string
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    Type string
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    UserAssignedIdentities map[string]UserAssignedIdentityResponse
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    principalId String
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    tenantId String
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    type String
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    userAssignedIdentities Map<String,UserAssignedIdentityResponse>
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    principalId string
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    tenantId string
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    type string
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    principal_id str
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    tenant_id str
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    type str
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    user_assigned_identities Mapping[str, UserAssignedIdentityResponse]
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    principalId String
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    tenantId String
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    type String
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    userAssignedIdentities Map<Property Map>
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    UserAssignedIdentityResponse

    ClientId string
    The client ID of the user assigned identity.
    ObjectId string
    The object ID of the user assigned identity.
    PrincipalId string
    The principal ID of the assigned identity.
    ResourceId string
    The resource ID of the user assigned identity.
    ClientId string
    The client ID of the user assigned identity.
    ObjectId string
    The object ID of the user assigned identity.
    PrincipalId string
    The principal ID of the assigned identity.
    ResourceId string
    The resource ID of the user assigned identity.
    clientId String
    The client ID of the user assigned identity.
    objectId String
    The object ID of the user assigned identity.
    principalId String
    The principal ID of the assigned identity.
    resourceId String
    The resource ID of the user assigned identity.
    clientId string
    The client ID of the user assigned identity.
    objectId string
    The object ID of the user assigned identity.
    principalId string
    The principal ID of the assigned identity.
    resourceId string
    The resource ID of the user assigned identity.
    client_id str
    The client ID of the user assigned identity.
    object_id str
    The object ID of the user assigned identity.
    principal_id str
    The principal ID of the assigned identity.
    resource_id str
    The resource ID of the user assigned identity.
    clientId String
    The client ID of the user assigned identity.
    objectId String
    The object ID of the user assigned identity.
    principalId String
    The principal ID of the assigned identity.
    resourceId String
    The resource ID of the user assigned identity.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-azure-native