Share via


Azure AD Only Authentications - Get

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/azureADOnlyAuthentications/default?api-version=2021-06-01

URI Parameters

Name In Required Type Description
azureADOnlyAuthenticationName
path True

AzureADOnlyAuthenticationName

name of the property

resourceGroupName
path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.

subscriptionId
path True

string

minLength: 1

The ID of the target subscription.

workspaceName
path True

string

The name of the workspace.

api-version
query True

string

minLength: 1

The API version to use for this operation.

Responses

Name Type Description
200 OK

AzureADOnlyAuthentication

OK

Other Status Codes

ErrorResponse

Examples

Get Azure Active Directory Only Authentication property

Sample request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-6852/providers/Microsoft.Synapse/workspaces/workspace-2080/azureADOnlyAuthentications/default?api-version=2021-06-01

Sample response

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-6852/providers/Microsoft.Synapse/workspaces/workspace-2080/azureADOnlyAuthentications/default",
  "name": "default",
  "type": "Microsoft.Synapse/workspaces/azureADOnlyAuthentications",
  "properties": {
    "azureADOnlyAuthentication": true,
    "creationDate": "2017-02-10T00:56:19.2Z",
    "state": "Consistent"
  }
}

Definitions

Name Description
AzureADOnlyAuthentication

Azure Active Directory Only Authentication Info

AzureADOnlyAuthenticationName

name of the property

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

state value

property configuration state

AzureADOnlyAuthentication

Azure Active Directory Only Authentication Info

Name Type 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

properties.azureADOnlyAuthentication

boolean

Azure Active Directory only Authentication enabled.

properties.creationDate

string (date-time)

property configuration date

properties.state

state value

property configuration state

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

AzureADOnlyAuthenticationName

name of the property

Value Description
default

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

state value

property configuration state

Value Description
Consistent
InConsistent
Updating