azure_ad_only_authentications

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

Overview

Name	azure_ad_only_authentications
Type	Resource
Id	azure.synapse.azure_ad_only_authentications

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	azureADOnlyAuthentication resource properties

list

Name	Datatype	Description
properties	object	azureADOnlyAuthentication resource properties

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName, azureADOnlyAuthenticationName		Gets a Azure Active Directory only authentication property
list	select	subscriptionId, resourceGroupName, workspaceName		Gets a list of Azure Active Directory only authentication property for a workspace
create	insert	subscriptionId, resourceGroupName, workspaceName, azureADOnlyAuthenticationName		Create or Update a Azure Active Directory only authentication property for the workspaces

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
azureADOnlyAuthenticationName	string	name of the property
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
workspaceName	string	The name of the workspace.

SELECT examples

get

Gets a Azure Active Directory only authentication property

SELECT
properties
FROM azure.synapse.azure_ad_only_authentications
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND azureADOnlyAuthenticationName = '{{ azureADOnlyAuthenticationName }}' -- required
;

list

Gets a list of Azure Active Directory only authentication property for a workspace

SELECT
properties
FROM azure.synapse.azure_ad_only_authentications
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
;

INSERT examples

create

Create or Update a Azure Active Directory only authentication property for the workspaces

INSERT INTO azure.synapse.azure_ad_only_authentications (
data__properties,
subscriptionId,
resourceGroupName,
workspaceName,
azureADOnlyAuthenticationName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ azureADOnlyAuthenticationName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: azure_ad_only_authentications
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the azure_ad_only_authentications resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the azure_ad_only_authentications resource.
    - name: workspaceName
      value: string
      description: Required parameter for the azure_ad_only_authentications resource.
    - name: azureADOnlyAuthenticationName
      value: string
      description: Required parameter for the azure_ad_only_authentications resource.
    - name: properties
      value: object
      description: |
        azureADOnlyAuthentication resource properties