Edit

Share via

Disable-AzSynapseActiveDirectoryOnlyAuthentication

Module:
Az.Synapse Module

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

Syntax

DisableByNameParameterSet (Default) 

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

DisableByParentObjectParameterSet 

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

DisableByResourceIdParameterSet 

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.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

Resource group name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

DisableByNameParameterSet
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceId

Resource identifier of Synapse workspace.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

DisableByResourceIdParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WorkspaceName

Name of Synapse workspace.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

DisableByNameParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WorkspaceObject

workspace input object, usually passed through the pipeline.

Parameter properties

Type:PSSynapseWorkspace
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

DisableByParentObjectParameterSet
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

PSSynapseWorkspace

Outputs

PSAzureADOnlyAuthentication