az synapse ad-only-auth

Manage Azure Active Directly only Authentication settings for this Synapse workspace.

Commands

Name	Description	Type	Status
az synapse ad-only-auth disable	Disable Azure Active Directly only Authentication for this Synapse workspace.	Core	GA
az synapse ad-only-auth enable	Enable Azure Active Directly only Authentication for this Synapse workspace.	Core	GA
az synapse ad-only-auth get	Get a specific Azure Active Directly only Authentication property.	Core	GA

az synapse ad-only-auth disable

Edit

Disable Azure Active Directly only Authentication for this Synapse workspace.

az synapse ad-only-auth disable --resource-group
                                --workspace-name

Examples

Disable Azure Active Directly only Authentication for this Synapse workspace.

az synapse ad-only-auth disable --workspace-name testsynapseworkspace \
  -g testresourcegroup

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name

The name of the workspace.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az synapse ad-only-auth enable

Edit

Enable Azure Active Directly only Authentication for this Synapse workspace.

az synapse ad-only-auth enable --resource-group
                               --workspace-name

Examples

Enable Azure Active Directly only Authentication for this Synapse workspace.

az synapse ad-only-auth enable --workspace-name testsynapseworkspace \
  -g testresourcegroup

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name

The name of the workspace.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az synapse ad-only-auth get

Edit

Get a specific Azure Active Directly only Authentication property.

az synapse ad-only-auth get --resource-group
                            --workspace-name

Examples

Get a specific Azure Active Directly only Authentication property.

az synapse ad-only-auth get --workspace-name testsynapseworkspace \
  -g testrg

Required Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name

The name of the workspace.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

Feedback

Was this page helpful?