private_link_for_azure_ads

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

Overview

Name	private_link_for_azure_ads
Type	Resource
Id	azure.azure_active_directory.private_link_for_azure_ads

Fields

The following fields are returned by SELECT queries:

get

OK -- Returns information about the private link policy.

Name	Datatype	Description
id	string	String Id used to locate any resource on Azure.
name	string	Name of this resource.
allTenants	boolean	Flag indicating whether all tenants are allowed
ownerTenantId	string	Guid of the owner tenant
resourceGroup	string	Name of the resource group
resourceName	string	Name of the private link policy resource
subscriptionId	string	Subscription Identifier
tags	object	Resource tags.
tenants	array	The list of tenantIds.
type	string	Type of this resource.

list

Successful request to get list of Private Links configuration objects For AzureAD.

Name	Datatype	Description
id	string	String Id used to locate any resource on Azure.
name	string	Name of this resource.
allTenants	boolean	Flag indicating whether all tenants are allowed
ownerTenantId	string	Guid of the owner tenant
resourceGroup	string	Name of the resource group
resourceName	string	Name of the private link policy resource
subscriptionId	string	Subscription Identifier
tags	object	Resource tags.
tenants	array	The list of tenantIds.
type	string	Type of this resource.

list_by_subscription

OK -- Returns a list of private link policies.

Name	Datatype	Description
id	string	String Id used to locate any resource on Azure.
name	string	Name of this resource.
allTenants	boolean	Flag indicating whether all tenants are allowed
ownerTenantId	string	Guid of the owner tenant
resourceGroup	string	Name of the resource group
resourceName	string	Name of the private link policy resource
subscriptionId	string	Subscription Identifier
tags	object	Resource tags.
tenants	array	The list of tenantIds.
type	string	Type of this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, policyName		Gets a private link policy with a given name.
list	select	subscriptionId, resourceGroupName		Operation to return the list of Private Link Policies For AzureAD scoped to the resourceGroup.
list_by_subscription	select	subscriptionId		Lists all Private Link Policies For AzureAD in the given subscription.
create	insert	subscriptionId, resourceGroupName, policyName		Creates a private link policy.
update	update	subscriptionId, resourceGroupName, policyName		Updates private link policy tags with specified values.
delete	delete	subscriptionId, resourceGroupName, policyName		Deletes a private link policy. When operation completes, status code 200 returned without content.

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
policyName	string	The name of the private link policy in Azure AD.
resourceGroupName	string	Name of an Azure resource group.
subscriptionId	string	Azure subscription ID.

SELECT examples

get

Gets a private link policy with a given name.

SELECT
id,
name,
allTenants,
ownerTenantId,
resourceGroup,
resourceName,
subscriptionId,
tags,
tenants,
type
FROM azure.azure_active_directory.private_link_for_azure_ads
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND policyName = '{{ policyName }}' -- required
;

list

Operation to return the list of Private Link Policies For AzureAD scoped to the resourceGroup.

SELECT
id,
name,
allTenants,
ownerTenantId,
resourceGroup,
resourceName,
subscriptionId,
tags,
tenants,
type
FROM azure.azure_active_directory.private_link_for_azure_ads
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Lists all Private Link Policies For AzureAD in the given subscription.

SELECT
id,
name,
allTenants,
ownerTenantId,
resourceGroup,
resourceName,
subscriptionId,
tags,
tenants,
type
FROM azure.azure_active_directory.private_link_for_azure_ads
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Creates a private link policy.

INSERT INTO azure.azure_active_directory.private_link_for_azure_ads (
data__name,
data__ownerTenantId,
data__allTenants,
data__tenants,
data__resourceName,
data__subscriptionId,
data__resourceGroup,
data__tags,
subscriptionId,
resourceGroupName,
policyName
)
SELECT 
'{{ name }}',
'{{ ownerTenantId }}',
{{ allTenants }},
'{{ tenants }}',
'{{ resourceName }}',
'{{ subscriptionId }}',
'{{ resourceGroup }}',
'{{ tags }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ policyName }}'
RETURNING
id,
name,
allTenants,
ownerTenantId,
resourceGroup,
resourceName,
subscriptionId,
tags,
tenants,
type
;

Manifest

# Description fields are for documentation purposes
- name: private_link_for_azure_ads
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the private_link_for_azure_ads resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the private_link_for_azure_ads resource.
    - name: policyName
      value: string
      description: Required parameter for the private_link_for_azure_ads resource.
    - name: name
      value: string
      description: |
        Name of this resource.
    - name: ownerTenantId
      value: string
      description: |
        Guid of the owner tenant
    - name: allTenants
      value: boolean
      description: |
        Flag indicating whether all tenants are allowed
    - name: tenants
      value: array
      description: |
        The list of tenantIds.
    - name: resourceName
      value: string
      description: |
        Name of the private link policy resource
    - name: subscriptionId
      value: string
      description: |
        Subscription Identifier
    - name: resourceGroup
      value: string
      description: |
        Name of the resource group
    - name: tags
      value: object
      description: |
        Resource tags.

UPDATE examples

update

Updates private link policy tags with specified values.

UPDATE azure.azure_active_directory.private_link_for_azure_ads
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND policyName = '{{ policyName }}' --required
RETURNING
id,
name,
allTenants,
ownerTenantId,
resourceGroup,
resourceName,
subscriptionId,
tags,
tenants,
type;

DELETE examples

delete

Deletes a private link policy. When operation completes, status code 200 returned without content.

DELETE FROM azure.azure_active_directory.private_link_for_azure_ads
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND policyName = '{{ policyName }}' --required
;