cluster_mesh_profiles

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

Overview

Name	cluster_mesh_profiles
Type	Resource
Id	azure.container_service_fleet.cluster_mesh_profiles

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.
memberSelector	object	Select the members of the mesh. * Only key/value pairs with the = operator are accepted in the label selector. * If empty or not specified, no Fleet members will be selected to join the mesh.
provisioningState	string	The provisioning state of the cluster mesh profile. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
status	object	The cluster mesh profile status.
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.
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.
memberSelector	object	Select the members of the mesh. * Only key/value pairs with the = operator are accepted in the label selector. * If empty or not specified, no Fleet members will be selected to join the mesh.
provisioningState	string	The provisioning state of the cluster mesh profile. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
status	object	The cluster mesh profile status.
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, cluster_mesh_profile_name, subscription_id		Get a ClusterMeshProfile.
list_by_fleet	select	resource_group_name, fleet_name, subscription_id		List ClusterMeshProfile resources by Fleet.
create_or_update	insert	resource_group_name, fleet_name, cluster_mesh_profile_name, subscription_id		Create a ClusterMeshProfile.
create_or_update	replace	resource_group_name, fleet_name, cluster_mesh_profile_name, subscription_id		Create a ClusterMeshProfile.
delete	delete	resource_group_name, fleet_name, cluster_mesh_profile_name, subscription_id		Delete a ClusterMeshProfile.
apply	exec	resource_group_name, fleet_name, cluster_mesh_profile_name, subscription_id		Applies the cluster mesh profile to selected fleet members.

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
cluster_mesh_profile_name	string	The name of the ClusterMeshProfile 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

SELECT examples

get

Get a ClusterMeshProfile.

SELECT
id,
name,
eTag,
memberSelector,
provisioningState,
status,
systemData,
type
FROM azure.container_service_fleet.cluster_mesh_profiles
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND fleet_name = '{{ fleet_name }}' -- required
AND cluster_mesh_profile_name = '{{ cluster_mesh_profile_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_fleet

List ClusterMeshProfile resources by Fleet.

SELECT
id,
name,
eTag,
memberSelector,
provisioningState,
status,
systemData,
type
FROM azure.container_service_fleet.cluster_mesh_profiles
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND fleet_name = '{{ fleet_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a ClusterMeshProfile.

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

Manifest

# Description fields are for documentation purposes
- name: cluster_mesh_profiles
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the cluster_mesh_profiles resource.
  - name: fleet_name
    value: "{{ fleet_name }}"
    description: Required parameter for the cluster_mesh_profiles resource.
  - name: cluster_mesh_profile_name
    value: "{{ cluster_mesh_profile_name }}"
    description: Required parameter for the cluster_mesh_profiles resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the cluster_mesh_profiles resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      memberSelector:
        byLabel: "{{ byLabel }}"
      status:
        state: "{{ state }}"
        lastAppliedMemberSelector:
          byLabel: "{{ byLabel }}"
        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 }}"

REPLACE examples

create_or_update

Create a ClusterMeshProfile.

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

DELETE examples

delete

Delete a ClusterMeshProfile.

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

Lifecycle Methods

apply

Applies the cluster mesh profile to selected fleet members.

EXEC azure.container_service_fleet.cluster_mesh_profiles.apply 
@resource_group_name='{{ resource_group_name }}' --required, 
@fleet_name='{{ fleet_name }}' --required, 
@cluster_mesh_profile_name='{{ cluster_mesh_profile_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;