Get-AzSynapseSqlActiveDirectoryAdministrator

Reference

Module:: Az.Synapse

Gets information about a Microsoft Entra administrator for Synapse Analytics Workspace.

Syntax

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

Get-AzSynapseSqlActiveDirectoryAdministrator
   -InputObject <PSSynapseWorkspace>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

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

Description

The Get-AzSynapseSqlActiveDirectoryAdministrator cmdlet gets information about a Microsoft Entra administrator for an Azure Synapse Analytics Workspace in the current subscription.

Examples

Example 1

Get-AzSynapseSqlActiveDirectoryAdministrator -WorkspaceName ContosoWorkspace

This command gets information about a Microsoft Entra administrator for a workspace named ContosoWorkspace.

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

-InputObject

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

-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

Inputs

PSSynapseWorkspace

Outputs

PSWorkspaceAadAdminInfo

Share via