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

Successfully retrieved a specified Azure Active Directory only authentication properties.

Name	Datatype	Description
properties	object	Resource properties.

list_by_server

Successfully retrieved the list of Azure Active Directory only authentication objects.

Name	Datatype	Description
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serverName, authenticationName, subscriptionId		Gets a specific Azure Active Directory only authentication property.
list_by_server	select	resourceGroupName, serverName, subscriptionId		Gets a list of server Azure Active Directory only authentications.
create_or_update	insert	resourceGroupName, serverName, authenticationName, subscriptionId		Sets Server Active Directory only authentication property or updates an existing server Active Directory only authentication property.
delete	delete	resourceGroupName, serverName, authenticationName, subscriptionId		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
authenticationName	string	The name of server azure active directory only authentication.
resourceGroupName	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName	string	The name of the server.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get

Gets a specific Azure Active Directory only authentication property.

SELECT
properties
FROM azure.sql.server_azure_ad_only_authentications
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND authenticationName = '{{ authenticationName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_server

Gets a list of server Azure Active Directory only authentications.

SELECT
properties
FROM azure.sql.server_azure_ad_only_authentications
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- 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 (
data__properties,
resourceGroupName,
serverName,
authenticationName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ authenticationName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: server_azure_ad_only_authentications
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the server_azure_ad_only_authentications resource.
    - name: serverName
      value: string
      description: Required parameter for the server_azure_ad_only_authentications resource.
    - name: authenticationName
      value: string
      description: Required parameter for the server_azure_ad_only_authentications resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the server_azure_ad_only_authentications resource.
    - name: properties
      value: object
      description: |
        Resource properties.

DELETE examples

delete

Deletes an existing server Active Directory only authentication property.

DELETE FROM azure.sql.server_azure_ad_only_authentications
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND authenticationName = '{{ authenticationName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;