fleets

Creates, updates, deletes, gets or lists a fleets resource.

Overview

Name	fleets
Type	Resource
Id	azure.container_service_fleet.fleets

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name 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.
hubProfile	object	The FleetHubProfile configures the Fleet's hub.
identity	object	Managed identity.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Creating, Updating, Deleting)
status	object	Status information for the fleet.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name 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.
hubProfile	object	The FleetHubProfile configures the Fleet's hub.
identity	object	Managed identity.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Creating, Updating, Deleting)
status	object	Status information for the fleet.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name 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.
hubProfile	object	The FleetHubProfile configures the Fleet's hub.
identity	object	Managed identity.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Creating, Updating, Deleting)
status	object	Status information for the fleet.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, fleet_name, subscription_id		Gets a Fleet.
list_by_resource_group	select	resource_group_name, subscription_id		Lists fleets in the specified subscription and resource group.
list_by_subscription	select	subscription_id	$top, $skipToken	Lists fleets in the specified subscription.
create_or_update	insert	resource_group_name, fleet_name, subscription_id, location		Creates or updates a Fleet.
update	update	resource_group_name, fleet_name, subscription_id		Update a Fleet.
create_or_update	replace	resource_group_name, fleet_name, subscription_id, location		Creates or updates a Fleet.
delete	delete	resource_group_name, fleet_name, subscription_id		Delete a Fleet.
list_credentials	exec	resource_group_name, fleet_name, subscription_id		Lists the user credentials of a Fleet.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
fleet_name	string	The name of the Fleet resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$skipToken	string	The page-continuation token to use with a paged version of this API. Default value is None.
$top	integer	The number of result items to return. Default value is None.

SELECT examples

get

Gets a Fleet.

SELECT
id,
name,
eTag,
hubProfile,
identity,
location,
provisioningState,
status,
systemData,
tags,
type
FROM azure.container_service_fleet.fleets
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND fleet_name = '{{ fleet_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists fleets in the specified subscription and resource group.

SELECT
id,
name,
eTag,
hubProfile,
identity,
location,
provisioningState,
status,
systemData,
tags,
type
FROM azure.container_service_fleet.fleets
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Lists fleets in the specified subscription.

SELECT
id,
name,
eTag,
hubProfile,
identity,
location,
provisioningState,
status,
systemData,
tags,
type
FROM azure.container_service_fleet.fleets
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

Creates or updates a Fleet.

INSERT INTO azure.container_service_fleet.fleets (
tags,
location,
properties,
identity,
resource_group_name,
fleet_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ fleet_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
eTag,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: fleets
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the fleets resource.
  - name: fleet_name
    value: "{{ fleet_name }}"
    description: Required parameter for the fleets resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the fleets resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      hubProfile:
        dnsPrefix: "{{ dnsPrefix }}"
        apiServerAccessProfile:
          enablePrivateCluster: {{ enablePrivateCluster }}
          enableVnetIntegration: {{ enableVnetIntegration }}
          subnetId: "{{ subnetId }}"
        agentProfile:
          subnetId: "{{ subnetId }}"
          vmSize: "{{ vmSize }}"
        fqdn: "{{ fqdn }}"
        kubernetesVersion: "{{ kubernetesVersion }}"
        portalFqdn: "{{ portalFqdn }}"
      status:
        lastOperationId: "{{ lastOperationId }}"
        lastOperationError:
          code: "{{ code }}"
          message: "{{ message }}"
          target: "{{ target }}"
          details:
            - code: "{{ code }}"
              message: "{{ message }}"
              target: "{{ target }}"
              details: "{{ details }}"
              additionalInfo: "{{ additionalInfo }}"
          additionalInfo:
            - type: "{{ type }}"
              info: "{{ info }}"
  - name: identity
    description: |
      Managed identity.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Update a Fleet.

UPDATE azure.container_service_fleet.fleets
SET 
tags = '{{ tags }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND fleet_name = '{{ fleet_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
eTag,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a Fleet.

REPLACE azure.container_service_fleet.fleets
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND fleet_name = '{{ fleet_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
eTag,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a Fleet.

DELETE FROM azure.container_service_fleet.fleets
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND fleet_name = '{{ fleet_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_credentials

Lists the user credentials of a Fleet.

EXEC azure.container_service_fleet.fleets.list_credentials 
@resource_group_name='{{ resource_group_name }}' --required, 
@fleet_name='{{ fleet_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;