fleet_members

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

Overview

Name	fleet_members
Type	Resource
Id	azure.container_service_fleet.fleet_members

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.
clusterResourceId	string	The ARM resource id of the cluster that joins the Fleet. Must be a valid Azure resource id. e.g.: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{clusterName}'. Required.
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.
group	string	The group this member belongs to for multi-cluster update management.
labels	object	The labels for the fleet member.
meshProperties	object	The Mesh Member Properties associated with this Fleet Member.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Joining", "Leaving", and "Updating". (Succeeded, Failed, Canceled, Joining, Leaving, Updating)
status	object	Status information of the last operation for fleet member.
systemData	object	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".

list_by_fleet

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.
clusterResourceId	string	The ARM resource id of the cluster that joins the Fleet. Must be a valid Azure resource id. e.g.: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{clusterName}'. Required.
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.
group	string	The group this member belongs to for multi-cluster update management.
labels	object	The labels for the fleet member.
meshProperties	object	The Mesh Member Properties associated with this Fleet Member.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Joining", "Leaving", and "Updating". (Succeeded, Failed, Canceled, Joining, Leaving, Updating)
status	object	Status information of the last operation for fleet member.
systemData	object	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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, fleet_name, fleet_member_name, subscription_id		Get a FleetMember.
list_by_fleet	select	resource_group_name, fleet_name, subscription_id	$top, $skipToken, $filter	List FleetMember resources by Fleet.
create	insert	resource_group_name, fleet_name, fleet_member_name, subscription_id		Create a FleetMember.
update	update	resource_group_name, fleet_name, fleet_member_name, subscription_id		Update a FleetMember.
delete	delete	resource_group_name, fleet_name, fleet_member_name, subscription_id		Delete a FleetMember.

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_member_name	string	The name of the Fleet member resource. Required.
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
$filter	string	Filter the result list using the given expression. Default value is None.
$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

Get a FleetMember.

SELECT
id,
name,
clusterResourceId,
eTag,
group,
labels,
meshProperties,
provisioningState,
status,
systemData,
type
FROM azure.container_service_fleet.fleet_members
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND fleet_name = '{{ fleet_name }}' -- required
AND fleet_member_name = '{{ fleet_member_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_fleet

List FleetMember resources by Fleet.

SELECT
id,
name,
clusterResourceId,
eTag,
group,
labels,
meshProperties,
provisioningState,
status,
systemData,
type
FROM azure.container_service_fleet.fleet_members
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND fleet_name = '{{ fleet_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
AND $filter = '{{ $filter }}'
;

INSERT examples

create

Create a FleetMember.

INSERT INTO azure.container_service_fleet.fleet_members (
properties,
resource_group_name,
fleet_name,
fleet_member_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ fleet_name }}',
'{{ fleet_member_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
eTag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: fleet_members
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the fleet_members resource.
  - name: fleet_name
    value: "{{ fleet_name }}"
    description: Required parameter for the fleet_members resource.
  - name: fleet_member_name
    value: "{{ fleet_member_name }}"
    description: Required parameter for the fleet_members resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the fleet_members resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      clusterResourceId: "{{ clusterResourceId }}"
      group: "{{ group }}"
      provisioningState: "{{ provisioningState }}"
      labels: "{{ labels }}"
      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 }}"
      meshProperties:
        ciliumProperties:
          id: {{ id }}
          name: "{{ name }}"
        status:
          state: "{{ state }}"
          lastUpdatedAt: "{{ lastUpdatedAt }}"
          lastOperationId: "{{ lastOperationId }}"
          error:
            code: "{{ code }}"
            message: "{{ message }}"
            target: "{{ target }}"
            details:
              - code: "{{ code }}"
                message: "{{ message }}"
                target: "{{ target }}"
                details: "{{ details }}"
                additionalInfo: "{{ additionalInfo }}"
            additionalInfo:
              - type: "{{ type }}"
                info: "{{ info }}"
        clusterMeshProfileResourceId: "{{ clusterMeshProfileResourceId }}"

UPDATE examples

update

Update a FleetMember.

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

DELETE examples

delete

Delete a FleetMember.

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