Set-AzSynapseSqlActiveDirectoryAdministrator

リファレンス

モジュール:: Az.Synapse

Synapse Analytics SQL プールの Microsoft Entra 管理者をプロビジョニングします。

構文

Set-AzSynapseSqlActiveDirectoryAdministrator
   [-ResourceGroupName <String>]
   -WorkspaceName <String>
   -DisplayName <String>
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzSynapseSqlActiveDirectoryAdministrator
   [-ResourceGroupName <String>]
   -WorkspaceName <String>
   -ObjectId <Guid>
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzSynapseSqlActiveDirectoryAdministrator
   -InputObject <PSSynapseWorkspace>
   -DisplayName <String>
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzSynapseSqlActiveDirectoryAdministrator
   -InputObject <PSSynapseWorkspace>
   -ObjectId <Guid>
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzSynapseSqlActiveDirectoryAdministrator
   -ResourceId <String>
   -DisplayName <String>
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzSynapseSqlActiveDirectoryAdministrator
   -ResourceId <String>
   -ObjectId <Guid>
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

Set-AzSynapseSqlActiveDirectory管理istrator コマンドレットは、現在のサブスクリプションで Azure Synapse Analytics ワークスペースの Microsoft Entra 管理者をプロビジョニングします。一度にプロビジョニングできる管理者は 1 人だけです。 Microsoft Entra ID の次のメンバーは、Synapse Analytics ワークスペース管理者としてプロビジョニングできます。

Microsoft Entra ID のネイティブメンバー
Microsoft Entra ID のフェデレーションメンバー
ネイティブメンバーまたはフェデレーションメンバーである他の Azure AD からインポートされたメンバー
セキュリティグループとして作成された Microsoft Entra グループ (Outlook.com、Hotmail.com、Live.com doメインなど) は、管理者としてはサポートされていません。その他のゲストアカウント (Gmail.com 内のアカウントや Yahoo.com メインアカウントなど) は、管理者としてサポートされていません。専用の Microsoft Entra グループを管理者としてプロビジョニングすることをお勧めします。

このコマンドレットは、入力パラメーターに従って、以下の Microsoft Graph API を呼び出す場合があります。

GET /users/{id}
GET /servicePrincipals/{id}
GET /groups/{id}

例

例 1

Set-AzSynapseSqlActiveDirectoryAdministrator -WorkspaceName ContosoWorkspace -DisplayName "DBAs"

このコマンドは、ContosoWorkspace という名前のワークスペースに DBA という名前の Microsoft Entra 管理者グループをプロビジョニングします。

例 2

Set-AzSynapseSqlActiveDirectoryAdministrator -WorkspaceName ContosoWorkspace -ObjectId "40b79501-b343-44ed-9ce7-da4c8cc7353b"

このコマンドは、ContosoWorkspace という名前のワークスペースの objectId によって Microsoft Entra 管理者をプロビジョニングします。

パラメーター

-AsJob

バックグラウンドでコマンドレットを実行する

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

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

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

-DisplayName

アクセス許可を付与するユーザーまたはグループの表示名を指定します。この表示名は、現在のサブスクリプションに関連付けられている Active Directory に存在する必要があります。

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

-InputObject

ワークスペース入力オブジェクト。通常はパイプラインを介して渡されます。

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

-ObjectId

アクセス許可を付与する Microsoft Entra ID のユーザーまたはグループのオブジェクト ID を指定します。

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

-ResourceGroupName

リソースグループ名。

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

-ResourceId

Synapse ワークスペースのリソース識別子。

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

-WhatIf

コマンドレットの実行時に発生する内容を示します。このコマンドレットは実行されません。

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WorkspaceName

Synapse ワークスペースの名前。

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

入力

PSSynapseWorkspace

出力

PSWorkspaceAadAdminInfo

次の方法で共有