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-AzSynapseSqlActiveDirectoryAdministrator コマンドレットは、現在のサブスクリプションで 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 ドメインなど) は、管理者としてサポートされていません。 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

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

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Confirm

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

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DefaultProfile

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

型:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DisplayName

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

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-InputObject

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

型:	PSSynapseWorkspace
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-ObjectId

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

型:	Guid
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ResourceGroupName

リソースグループ名。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ResourceId

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

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WhatIf

コマンドレットを実行した場合の動作を示します。コマンドレットは実行されません。

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WorkspaceName

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

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

PSSynapseWorkspace

出力

PSWorkspaceAadAdminInfo

次の方法で共有