Disable-AzSynapseActiveDirectoryOnlyAuthentication

Module:

Az.Synapse

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

Syntax

Disable-AzSynapseActiveDirectoryOnlyAuthentication
       [-ResourceGroupName <String>]
       -WorkspaceName <String>
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Disable-AzSynapseActiveDirectoryOnlyAuthentication
       -WorkspaceObject <PSSynapseWorkspace>
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Disable-AzSynapseActiveDirectoryOnlyAuthentication
       -ResourceId <String>
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

The Disable-AzSynapseActiveDirectoryOnlyAuthentication cmdlet disables Microsoft Entra-only authentication for a specific Synapse workspace.

Examples

Example 1

Disable-AzSynapseActiveDirectoryOnlyAuthentication -WorkspaceName ContosoWorkspace

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

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

Example 2

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

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

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

Example 3

Disable-AzSynapseActiveDirectoryOnlyAuthentication -ResourceId /subscriptions/21686af7-58ec-4f4d-9c68-f431f4db4edd/resourceGroups/ContosoResourceGroup/providers/Microsoft.Synapse/workspaces/ContosoWorkspace

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

This command disables 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