Get-AzSynapseActiveDirectoryOnlyAuthentication

Module:

Az.Synapse

Gets Microsoft Entra-only authentication for a specific Synapse workspace.

Syntax

Get-AzSynapseActiveDirectoryOnlyAuthentication
   [-ResourceGroupName <String>]
   -WorkspaceName <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzSynapseActiveDirectoryOnlyAuthentication
   -WorkspaceObject <PSSynapseWorkspace>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzSynapseActiveDirectoryOnlyAuthentication
   -ResourceId <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzSynapseActiveDirectoryOnlyAuthentication cmdlet gets Microsoft Entra-only authentication for a specific Synapse workspace.

Examples

Example 1

Get-AzSynapseActiveDirectoryOnlyAuthentication -WorkspaceName ContosoWorkspace

WorkspaceName     AzureADOnlyAuthenticationProperty State      CreationDate
-------------     --------------------------------- -----      ------------
ContosoWorkspace                               True Consistent 3/23/2022 8:27:47 AM

This command gets Microsoft Entra-only authentication status for Synapse workspace ContosoWorkspace.

Example 2

$ws = Get-AzSynapseWorkspace -Name ContosoWorkspace
$ws | Get-AzSynapseActiveDirectoryOnlyAuthentication

WorkspaceName     AzureADOnlyAuthenticationProperty State      CreationDate
-------------     --------------------------------- -----      ------------
ContosoWorkspace                               True Consistent 3/23/2022 8:27:47 AM

This command gets Microsoft Entra-only authentication status for Synapse workspace ContosoWorkspace through pipeline.

Example 3

Get-AzSynapseActiveDirectoryOnlyAuthentication -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace

WorkspaceName     AzureADOnlyAuthenticationProperty State      CreationDate
-------------     --------------------------------- -----      ------------
ContosoWorkspace                               True Consistent 3/23/2022 8:27:47 AM

This command gets Microsoft Entra-only authentication for workspace ContosoWorkspace by ResourceId.

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

Resource group name.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceId

Resource identifier of Synapse workspace.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-WorkspaceName

Name of Synapse workspace.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-WorkspaceObject

workspace input object, usually passed through the pipeline.

Type:	PSSynapseWorkspace
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

Inputs

PSSynapseWorkspace

Outputs

PSAzureADOnlyAuthentication