Enable-AzSynapseActiveDirectoryOnlyAuthentication

Reference

Module:: Az.Synapse

Enables Microsoft Entra-only authentication for a specific Synapse workspace.

Syntax

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>]

Description

The Enable-AzSynapseActiveDirectoryOnlyAuthentication cmdlet enables Microsoft Entra-only authentication for a specific Synapse workspace.

Examples

Example 1

Enable-AzSynapseActiveDirectoryOnlyAuthentication -WorkspaceName ContosoWorkspace

WorkspaceName     AzureADOnlyAuthenticationProperty State      CreationDate
-------------     --------------------------------- -----      ------------
ContosoWorkspace                               True Consistent 3/23/2022 8:27:47 AM

This command enables Microsoft Entra-only authentication for workspace ContosoWorkspace.

Example 2

$ws = Get-AzSynapseWorkspace -WorkspaceName ContosoWorkspace
$ws | Enable-AzSynapseActiveDirectoryOnlyAuthentication

WorkspaceName     AzureADOnlyAuthenticationProperty State      CreationDate
-------------     --------------------------------- -----      ------------
ContosoWorkspace                               True Consistent 3/23/2022 8:27:47 AM

This command enables Microsoft Entra-only authentication for workspace ContosoWorkspace through pipeline.

Example 3

Enable-AzSynapseActiveDirectoryOnlyAuthentication -ResourceId /subscriptions/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace

WorkspaceName     AzureADOnlyAuthenticationProperty State      CreationDate
-------------     --------------------------------- -----      ------------
ContosoWorkspace                               True Consistent 3/23/2022 8:27:47 AM

This command enables Microsoft Entra-only authentication for workspace ContosoWorkspace by ResourceId.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-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

-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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
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

-WorkspaceObject

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

Inputs

PSSynapseWorkspace

Outputs

PSAzureADOnlyAuthentication

Compartilhar via