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
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.
azureADOnlyAuthentication	boolean	Azure Active Directory only Authentication enabled.
creationDate	string (date-time)	property configuration date.
state	string	property configuration state. Known values are: "Consistent", "InConsistent", and "Updating".
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.
azureADOnlyAuthentication	boolean	Azure Active Directory only Authentication enabled.
creationDate	string (date-time)	property configuration date.
state	string	property configuration state. Known values are: "Consistent", "InConsistent", and "Updating".
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, workspace_name, azure_ad_only_authentication_name, subscription_id		Get Azure Active Directory only authentication property. Gets a Azure Active Directory only authentication property.
list	select	resource_group_name, workspace_name, subscription_id		Gets a list of Azure Active Directory only authentication property. Gets a list of Azure Active Directory only authentication property for a workspace.
create	insert	resource_group_name, workspace_name, azure_ad_only_authentication_name, subscription_id		Create or Update Azure Active Directory only authentication property. 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
azure_ad_only_authentication_name	string	name of the property. "default" Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
workspace_name	string	The name of the workspace. Required.

SELECT examples

get

Get Azure Active Directory only authentication property. Gets a Azure Active Directory only authentication property.

SELECT
id,
name,
azureADOnlyAuthentication,
creationDate,
state,
type
FROM azure.synapse.azure_ad_only_authentications
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND azure_ad_only_authentication_name = '{{ azure_ad_only_authentication_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

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

SELECT
id,
name,
azureADOnlyAuthentication,
creationDate,
state,
type
FROM azure.synapse.azure_ad_only_authentications
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

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

INSERT INTO azure.synapse.azure_ad_only_authentications (
properties,
resource_group_name,
workspace_name,
azure_ad_only_authentication_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ azure_ad_only_authentication_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: azure_ad_only_authentications
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the azure_ad_only_authentications resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the azure_ad_only_authentications resource.
  - name: azure_ad_only_authentication_name
    value: "{{ azure_ad_only_authentication_name }}"
    description: Required parameter for the azure_ad_only_authentications resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the azure_ad_only_authentications resource.
  - name: properties
    value:
      azureADOnlyAuthentication: {{ azureADOnlyAuthentication }}