mesh_memberships

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

Overview

Name	mesh_memberships
Type	Resource
Id	azure.container_service.mesh_memberships

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.
managedBy	string	The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.
managedMeshID	string	The ARM resource id for the managed mesh member. This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppLink/applinks/{appLinkName}/appLinkMembers/{appLinkMemberName}'. Visit https://aka.ms/applink _ for more information. Required.
privateConnectProfile	object	Profile for configuring private connectivity between the mesh control plane and member clusters. When configured, communication between the mesh control plane and this member cluster occurs over private network instead of public networks. Visit https://aka.ms/applink _ for more information.
provisioningState	string	The current provisioning state of the Mesh Membership. Known values are: "Canceled", "Creating", "Deleting", "Failed", "Succeeded", and "Updating". (Canceled, Creating, Deleting, Failed, Succeeded, Updating)
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_managed_cluster

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.
managedBy	string	The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.
managedMeshID	string	The ARM resource id for the managed mesh member. This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppLink/applinks/{appLinkName}/appLinkMembers/{appLinkMemberName}'. Visit https://aka.ms/applink _ for more information. Required.
privateConnectProfile	object	Profile for configuring private connectivity between the mesh control plane and member clusters. When configured, communication between the mesh control plane and this member cluster occurs over private network instead of public networks. Visit https://aka.ms/applink _ for more information.
provisioningState	string	The current provisioning state of the Mesh Membership. Known values are: "Canceled", "Creating", "Deleting", "Failed", "Succeeded", and "Updating". (Canceled, Creating, Deleting, Failed, Succeeded, Updating)
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, resource_name, mesh_membership_name, subscription_id		Gets the mesh membership of a managed cluster.
list_by_managed_cluster	select	resource_group_name, resource_name, subscription_id		Lists mesh memberships in a managed cluster.
create_or_update	insert	resource_group_name, resource_name, mesh_membership_name, subscription_id		Creates or updates the mesh membership of a managed cluster.
create_or_update	replace	resource_group_name, resource_name, mesh_membership_name, subscription_id		Creates or updates the mesh membership of a managed cluster.
delete	delete	resource_group_name, resource_name, mesh_membership_name, subscription_id		Deletes the mesh membership of a managed cluster.

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
mesh_membership_name	string	The name of the mesh membership. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	The name of the managed cluster resource. Required.
subscription_id	string

SELECT examples

get

Gets the mesh membership of a managed cluster.

SELECT
id,
name,
eTag,
managedBy,
managedMeshID,
privateConnectProfile,
provisioningState,
systemData,
type
FROM azure.container_service.mesh_memberships
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND mesh_membership_name = '{{ mesh_membership_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_managed_cluster

Lists mesh memberships in a managed cluster.

SELECT
id,
name,
eTag,
managedBy,
managedMeshID,
privateConnectProfile,
provisioningState,
systemData,
type
FROM azure.container_service.mesh_memberships
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates the mesh membership of a managed cluster.

INSERT INTO azure.container_service.mesh_memberships (
properties,
managedBy,
resource_group_name,
resource_name,
mesh_membership_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ managedBy }}',
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ mesh_membership_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
eTag,
managedBy,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: mesh_memberships
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the mesh_memberships resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the mesh_memberships resource.
  - name: mesh_membership_name
    value: "{{ mesh_membership_name }}"
    description: Required parameter for the mesh_memberships resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the mesh_memberships resource.
  - name: properties
    description: |
      Mesh membership properties of a managed cluster.
    value:
      provisioningState: "{{ provisioningState }}"
      privateConnectProfile:
        privateIpAddress: "{{ privateIpAddress }}"
        subnetResourceId: "{{ subnetResourceId }}"
      managedMeshID: "{{ managedMeshID }}"
  - name: managedBy
    value: "{{ managedBy }}"
    description: |
      The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.

REPLACE examples

create_or_update

Creates or updates the mesh membership of a managed cluster.

REPLACE azure.container_service.mesh_memberships
SET 
properties = '{{ properties }}',
managedBy = '{{ managedBy }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND mesh_membership_name = '{{ mesh_membership_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
eTag,
managedBy,
properties,
systemData,
type;

DELETE examples

delete

Deletes the mesh membership of a managed cluster.

DELETE FROM azure.container_service.mesh_memberships
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND mesh_membership_name = '{{ mesh_membership_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;