app_link_members

Creates, updates, deletes, gets or lists an app_link_members resource.

Overview

Name	app_link_members
Type	Resource
Id	azure.app_network.app_link_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.
clusterType	string	Cluster type. "AKS" (AKS)
connectivityProfile	object	Connectivity profile.
location	string	The geo-location where the resource lives. Required.
metadata	object	AppLink Member Metadata. Required.
observabilityProfile	object	Observability profile.
provisioningState	string	Provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
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".
upgradeProfile	object	Upgrade profile.

list_by_app_link

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.
clusterType	string	Cluster type. "AKS" (AKS)
connectivityProfile	object	Connectivity profile.
location	string	The geo-location where the resource lives. Required.
metadata	object	AppLink Member Metadata. Required.
observabilityProfile	object	Observability profile.
provisioningState	string	Provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
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".
upgradeProfile	object	Upgrade profile.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, app_link_name, app_link_member_name, subscription_id		Get an AppLinkMember.
list_by_app_link	select	resource_group_name, app_link_name, subscription_id		List AppLinkMember resources by AppLink.
create_or_update	insert	resource_group_name, app_link_name, app_link_member_name, subscription_id, location		Create an AppLinkMember.
update	update	resource_group_name, app_link_name, app_link_member_name, subscription_id		Update an AppLinkMember.
create_or_update	replace	resource_group_name, app_link_name, app_link_member_name, subscription_id, location		Create an AppLinkMember.
delete	delete	resource_group_name, app_link_name, app_link_member_name, subscription_id		Delete an AppLinkMember.

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
app_link_member_name	string	The name of the AppLinkMember. Required.
app_link_name	string	The name of the AppLink. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get an AppLinkMember.

SELECT
id,
name,
clusterType,
connectivityProfile,
location,
metadata,
observabilityProfile,
provisioningState,
systemData,
tags,
type,
upgradeProfile
FROM azure.app_network.app_link_members
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND app_link_name = '{{ app_link_name }}' -- required
AND app_link_member_name = '{{ app_link_member_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_app_link

List AppLinkMember resources by AppLink.

SELECT
id,
name,
clusterType,
connectivityProfile,
location,
metadata,
observabilityProfile,
provisioningState,
systemData,
tags,
type,
upgradeProfile
FROM azure.app_network.app_link_members
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND app_link_name = '{{ app_link_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create an AppLinkMember.

INSERT INTO azure.app_network.app_link_members (
tags,
location,
properties,
resource_group_name,
app_link_name,
app_link_member_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ app_link_name }}',
'{{ app_link_member_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: app_link_members
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the app_link_members resource.
  - name: app_link_name
    value: "{{ app_link_name }}"
    description: Required parameter for the app_link_members resource.
  - name: app_link_member_name
    value: "{{ app_link_member_name }}"
    description: Required parameter for the app_link_members resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the app_link_members 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:
      clusterType: "{{ clusterType }}"
      metadata:
        resourceId: "{{ resourceId }}"
      upgradeProfile:
        mode: "{{ mode }}"
        fullyManagedUpgradeProfile:
          releaseChannel: "{{ releaseChannel }}"
        selfManagedUpgradeProfile:
          version: "{{ version }}"
      observabilityProfile:
        metrics:
          metricsEndpoint: "{{ metricsEndpoint }}"
      connectivityProfile:
        eastWestGateway:
          visibility: "{{ visibility }}"
        privateConnect:
          subnetResourceId: "{{ subnetResourceId }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Update an AppLinkMember.

UPDATE azure.app_network.app_link_members
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND app_link_name = '{{ app_link_name }}' --required
AND app_link_member_name = '{{ app_link_member_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create an AppLinkMember.

REPLACE azure.app_network.app_link_members
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND app_link_name = '{{ app_link_name }}' --required
AND app_link_member_name = '{{ app_link_member_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete an AppLinkMember.

DELETE FROM azure.app_network.app_link_members
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND app_link_name = '{{ app_link_name }}' --required
AND app_link_member_name = '{{ app_link_member_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;