Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. containerservice
  5. getFleet
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.containerservice.getFleet

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets a Fleet. Azure REST API version: 2023-03-15-preview.

Other available API versions: 2022-07-02-preview, 2023-06-15-preview, 2023-08-15-preview, 2023-10-15, 2024-02-02-preview, 2024-04-01, 2024-05-02-preview.

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>
Copy
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]
Copy
func LookupFleet(ctx *Context, args *LookupFleetArgs, opts ...InvokeOption) (*LookupFleetResult, error)
func LookupFleetOutput(ctx *Context, args *LookupFleetOutputArgs, opts ...InvokeOption) LookupFleetResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetFleetResult> getFleet(GetFleetArgs args, InvokeOptions options)
public static Output<GetFleetResult> getFleet(GetFleetArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:containerservice:getFleet
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

FleetName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Fleet resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
FleetName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Fleet resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
fleetName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Fleet resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
fleetName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Fleet resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
fleet_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Fleet resource.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
fleetName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Fleet resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getFleet Result

The following output properties are available:

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.
Tags Dictionary<string, string>
Resource tags.
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.
Tags map[string]string
Resource tags.
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.
tags Map<String,String>
Resource tags.
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.
tags {[key: string]: string}
Resource tags.
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.
tags Mapping[str, str]
Resource tags.
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.
tags Map<String>
Resource tags.

Supporting Types

FleetHubProfileResponse

Fqdn This property is required. string
The FQDN of the Fleet hub.
KubernetesVersion This property is required. string
The Kubernetes version of the Fleet hub.
DnsPrefix string
DNS prefix used to create the FQDN for the Fleet hub.
Fqdn This property is required. string
The FQDN of the Fleet hub.
KubernetesVersion This property is required. string
The Kubernetes version of the Fleet hub.
DnsPrefix string
DNS prefix used to create the FQDN for the Fleet hub.
fqdn This property is required. String
The FQDN of the Fleet hub.
kubernetesVersion This property is required. String
The Kubernetes version of the Fleet hub.
dnsPrefix String
DNS prefix used to create the FQDN for the Fleet hub.
fqdn This property is required. string
The FQDN of the Fleet hub.
kubernetesVersion This property is required. string
The Kubernetes version of the Fleet hub.
dnsPrefix string
DNS prefix used to create the FQDN for the Fleet hub.
fqdn This property is required. str
The FQDN of the Fleet hub.
kubernetes_version This property is required. str
The Kubernetes version of the Fleet hub.
dns_prefix str
DNS prefix used to create the FQDN for the Fleet hub.
fqdn This property is required. String
The FQDN of the Fleet hub.
kubernetesVersion This property is required. String
The Kubernetes version of the Fleet hub.
dnsPrefix String
DNS prefix used to create the FQDN for the Fleet hub.

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.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native