Enable-AzSynapseActiveDirectoryOnlyAuthentication
特定の Synapse ワークスペースに対して Microsoft Entra 専用認証を有効にします。
構文
EnableByNameParameterSet (既定)
Enable-AzSynapseActiveDirectoryOnlyAuthentication
-WorkspaceName <String>
[-ResourceGroupName <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
EnableByParentObjectParameterSet
Enable-AzSynapseActiveDirectoryOnlyAuthentication
-WorkspaceObject <PSSynapseWorkspace>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
EnableByResourceIdParameterSet
Enable-AzSynapseActiveDirectoryOnlyAuthentication
-ResourceId <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Enable-AzSynapseActiveDirectoryOnlyAuthentication コマンドレットは、特定の Synapse ワークスペースに対して Microsoft Entra 専用認証を有効にします。
例
例 1
Enable-AzSynapseActiveDirectoryOnlyAuthentication -WorkspaceName ContosoWorkspace
WorkspaceName AzureADOnlyAuthenticationProperty State CreationDate
------------- --------------------------------- ----- ------------
ContosoWorkspace True Consistent 3/23/2022 8:27:47 AM
このコマンドは、ワークスペース ContosoWorkspace に対して Microsoft Entra 専用認証を有効にします。
例 2
$ws = Get-AzSynapseWorkspace -WorkspaceName ContosoWorkspace
$ws | Enable-AzSynapseActiveDirectoryOnlyAuthentication
WorkspaceName AzureADOnlyAuthenticationProperty State CreationDate
------------- --------------------------------- ----- ------------
ContosoWorkspace True Consistent 3/23/2022 8:27:47 AM
このコマンドを実行すると、パイプライン経由でワークスペース ContosoWorkspace に対して Microsoft Entra 専用認証が有効になります。
例 3
Enable-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
このコマンドは、ワークスペース ContosoWorkspace by ResourceId に対して Microsoft Entra 専用認証を有効にします。
パラメーター
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DefaultProfile
Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。
パラメーターのプロパティ
| 型: | IAzureContextContainer
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ResourceGroupName
リソース グループ名。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
EnableByNameParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ResourceId
Synapse ワークスペースのリソース識別子。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
EnableByResourceIdParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。
コマンドレットは実行されません。
パラメーターのプロパティ
| 型: | SwitchParameter
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WorkspaceName
Synapse ワークスペースの名前。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
EnableByNameParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WorkspaceObject
ワークスペース入力オブジェクト。通常はパイプラインを介して渡されます。
パラメーターのプロパティ
パラメーター セット
EnableByParentObjectParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
出力
