你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Enable-AzSynapseActiveDirectoryOnlyAuthentication

为特定的 Synapse 工作区启用仅限 Microsoft Entra 的身份验证。

语法

Enable-AzSynapseActiveDirectoryOnlyAuthentication
      [-ResourceGroupName <String>]
      -WorkspaceName <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Enable-AzSynapseActiveDirectoryOnlyAuthentication
      -WorkspaceObject <PSSynapseWorkspace>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Enable-AzSynapseActiveDirectoryOnlyAuthentication
      -ResourceId <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

说明

Enable-AzSynapseActiveDirectoryOnlyAuthentication cmdlet 为特定的 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

提示你在运行 cmdlet 之前进行确认。

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

-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

显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。

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

-WorkspaceObject

工作区输入对象,通常通过管道传递。

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

输入

PSSynapseWorkspace

输出

PSAzureADOnlyAuthentication