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

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

Name	Accessible by	Required Params	Description
get	SELECT	policyName, resourceGroupName, subscriptionId	Gets a private link policy with a given name.
list	SELECT	resourceGroupName, subscriptionId	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	policyName, resourceGroupName, subscriptionId	Creates a private link policy.
delete	DELETE	policyName, resourceGroupName, subscriptionId	Deletes a private link policy. When operation completes, status code 200 returned without content.
update	UPDATE	policyName, resourceGroupName, subscriptionId	Updates private link policy tags with specified values.

SELECT examples

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 }}';

INSERT example

Use the following StackQL query and manifest file to create a new private_link_for_azure_ads resource.

All Properties

/*+ create */
INSERT INTO azure.azure_active_directory.private_link_for_azure_ads (
policyName,
resourceGroupName,
subscriptionId,
name,
ownerTenantId,
allTenants,
tenants,
resourceName,
subscriptionId,
resourceGroup,
tags
)
SELECT 
'{{ policyName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ name }}',
'{{ ownerTenantId }}',
{{ allTenants }},
'{{ tenants }}',
'{{ resourceName }}',
'{{ subscriptionId }}',
'{{ resourceGroup }}',
'{{ tags }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: ownerTenantId
      value: string
    - name: allTenants
      value: boolean
    - name: tenants
      value:
        - string
    - name: resourceName
      value: string
    - name: subscriptionId
      value: string
    - name: resourceGroup
      value: string
    - name: tags
      value: object
    - name: id
      value: string
    - name: type
      value: string

UPDATE example

Updates a private_link_for_azure_ads resource.

/*+ update */
UPDATE azure.azure_active_directory.private_link_for_azure_ads
SET 
tags = '{{ tags }}'
WHERE 
policyName = '{{ policyName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified private_link_for_azure_ads resource.

/*+ delete */
DELETE FROM azure.azure_active_directory.private_link_for_azure_ads
WHERE policyName = '{{ policyName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';