server_azure_ad_only_authentications

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

Overview

Name	server_azure_ad_only_authentications
Type	Resource
Id	azure.sql.server_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. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_server

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. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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, server_name, authentication_name, subscription_id		Gets a specific Azure Active Directory only authentication property.
list_by_server	select	resource_group_name, server_name, subscription_id		Gets a list of server Azure Active Directory only authentications.
create_or_update	insert	resource_group_name, server_name, authentication_name, subscription_id		Sets Server Active Directory only authentication property or updates an existing server Active Directory only authentication property.
create_or_update	replace	resource_group_name, server_name, authentication_name, subscription_id		Sets Server Active Directory only authentication property or updates an existing server Active Directory only authentication property.
delete	delete	resource_group_name, server_name, authentication_name, subscription_id		Deletes an existing server Active Directory only authentication property.

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
authentication_name	string	The name of server azure active directory only authentication. "Default" Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
server_name	string	The name of the server. Required.
subscription_id	string

SELECT examples

get

Gets a specific Azure Active Directory only authentication property.

SELECT
id,
name,
azureADOnlyAuthentication,
systemData,
type
FROM azure.sql.server_azure_ad_only_authentications
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND authentication_name = '{{ authentication_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_server

Gets a list of server Azure Active Directory only authentications.

SELECT
id,
name,
azureADOnlyAuthentication,
systemData,
type
FROM azure.sql.server_azure_ad_only_authentications
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Sets Server Active Directory only authentication property or updates an existing server Active Directory only authentication property.

INSERT INTO azure.sql.server_azure_ad_only_authentications (
properties,
resource_group_name,
server_name,
authentication_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ authentication_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: server_azure_ad_only_authentications
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the server_azure_ad_only_authentications resource.
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the server_azure_ad_only_authentications resource.
  - name: authentication_name
    value: "{{ authentication_name }}"
    description: Required parameter for the server_azure_ad_only_authentications resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the server_azure_ad_only_authentications resource.
  - name: properties
    description: |
      Resource properties.
    value:
      azureADOnlyAuthentication: {{ azureADOnlyAuthentication }}

REPLACE examples

create_or_update

Sets Server Active Directory only authentication property or updates an existing server Active Directory only authentication property.

REPLACE azure.sql.server_azure_ad_only_authentications
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND authentication_name = '{{ authentication_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes an existing server Active Directory only authentication property.

DELETE FROM azure.sql.server_azure_ad_only_authentications
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND authentication_name = '{{ authentication_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;