private_link_scopes

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

Overview

Name	private_link_scopes
Type	Resource
Id	azure.kubernetes_configuration.private_link_scopes

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	Managed Cluster ARM ID for the private link scope (Required). Required.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	The collection of associated Private Endpoint Connections.
privateLinkScopeId	string	The Guid id of the private link scope.
provisioningState	string	Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Creating, Updating, Deleting)
publicNetworkAccess	string	Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
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.
clusterResourceId	string	Managed Cluster ARM ID for the private link scope (Required). Required.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	The collection of associated Private Endpoint Connections.
privateLinkScopeId	string	The Guid id of the private link scope.
provisioningState	string	Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Creating, Updating, Deleting)
publicNetworkAccess	string	Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
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

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	Managed Cluster ARM ID for the private link scope (Required). Required.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	The collection of associated Private Endpoint Connections.
privateLinkScopeId	string	The Guid id of the private link scope.
provisioningState	string	Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Creating, Updating, Deleting)
publicNetworkAccess	string	Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
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, scope_name, subscription_id		Returns a Azure Arc PrivateLinkScope.
list_by_resource_group	select	resource_group_name, subscription_id		Gets a list of Azure Arc PrivateLinkScopes within a resource group.
list	select	subscription_id		Gets a list of all Azure Arc PrivateLinkScopes within a subscription.
create_or_update	insert	resource_group_name, scope_name, subscription_id, location		Creates (or updates) a Azure Arc PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.
update_tags	update	resource_group_name, scope_name, subscription_id		Updates an existing PrivateLinkScope's tags. To update other fields use the CreateOrUpdate method.
create_or_update	replace	resource_group_name, scope_name, subscription_id, location		Creates (or updates) a Azure Arc PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.
delete	delete	resource_group_name, scope_name, subscription_id		Deletes a Azure Arc PrivateLinkScope.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
scope_name	string	The name of the Azure Arc PrivateLinkScope resource. Required.
subscription_id	string

SELECT examples

get

Returns a Azure Arc PrivateLinkScope.

SELECT
id,
name,
clusterResourceId,
location,
privateEndpointConnections,
privateLinkScopeId,
provisioningState,
publicNetworkAccess,
systemData,
tags,
type
FROM azure.kubernetes_configuration.private_link_scopes
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND scope_name = '{{ scope_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Gets a list of Azure Arc PrivateLinkScopes within a resource group.

SELECT
id,
name,
clusterResourceId,
location,
privateEndpointConnections,
privateLinkScopeId,
provisioningState,
publicNetworkAccess,
systemData,
tags,
type
FROM azure.kubernetes_configuration.private_link_scopes
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets a list of all Azure Arc PrivateLinkScopes within a subscription.

SELECT
id,
name,
clusterResourceId,
location,
privateEndpointConnections,
privateLinkScopeId,
provisioningState,
publicNetworkAccess,
systemData,
tags,
type
FROM azure.kubernetes_configuration.private_link_scopes
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates (or updates) a Azure Arc PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.

INSERT INTO azure.kubernetes_configuration.private_link_scopes (
tags,
location,
properties,
resource_group_name,
scope_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ scope_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: private_link_scopes
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the private_link_scopes resource.
  - name: scope_name
    value: "{{ scope_name }}"
    description: Required parameter for the private_link_scopes resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the private_link_scopes resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Properties that define a Azure Arc PrivateLinkScope resource.
    value:
      publicNetworkAccess: "{{ publicNetworkAccess }}"
      provisioningState: "{{ provisioningState }}"
      clusterResourceId: "{{ clusterResourceId }}"
      privateLinkScopeId: "{{ privateLinkScopeId }}"
      privateEndpointConnections:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          systemData:
            createdBy: "{{ createdBy }}"
            createdByType: "{{ createdByType }}"
            createdAt: "{{ createdAt }}"
            lastModifiedBy: "{{ lastModifiedBy }}"
            lastModifiedByType: "{{ lastModifiedByType }}"
            lastModifiedAt: "{{ lastModifiedAt }}"
          properties:
            privateEndpoint:
              id: "{{ id }}"
            privateLinkServiceConnectionState:
              status: "{{ status }}"
              description: "{{ description }}"
              actionsRequired: "{{ actionsRequired }}"
            provisioningState: "{{ provisioningState }}"

UPDATE examples

update_tags

Updates an existing PrivateLinkScope's tags. To update other fields use the CreateOrUpdate method.

UPDATE azure.kubernetes_configuration.private_link_scopes
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND scope_name = '{{ scope_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates (or updates) a Azure Arc PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.

REPLACE azure.kubernetes_configuration.private_link_scopes
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND scope_name = '{{ scope_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a Azure Arc PrivateLinkScope.

DELETE FROM azure.kubernetes_configuration.private_link_scopes
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND scope_name = '{{ scope_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;