Share via

az synapse managed-private-endpoints

Manage synapse managed private endpoints.

Commands

Name Description Type Status
az synapse managed-private-endpoints create

Create a synapse managed private endpoints.

 Core GA
az synapse managed-private-endpoints delete

Delete synapse managed private endpoints in a workspace.

 Core GA
az synapse managed-private-endpoints list

List synapse managed private endpoints in a workspace.

 Core GA
az synapse managed-private-endpoints show

Get a synapse managed private endpoints.

 Core GA

az synapse managed-private-endpoints create

Edit

Create a synapse managed private endpoints.

az synapse managed-private-endpoints create --file
                                            --pe-name
                                            --workspace-name

Examples

Create a synapse managed private endpoints. Definition file should contains privateLinkResourceId and groupId.

az synapse managed-private-endpoints create --workspace-name testsynapseworkspace \
  --pe-name testendpointname \
  --file @path/test.json
test.json {"privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test/providers/Microsoft.Storage/storageAccounts/test", "groupId": "blob"}

Required Parameters

--file

Properties may be supplied from a JSON file using the @{path} syntax or a JSON string.

--pe-name

The managed private endpoint name.

--workspace-name

The workspace name.

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 managed-private-endpoints delete

Edit

Delete synapse managed private endpoints in a workspace.

az synapse managed-private-endpoints delete --pe-name
                                            [--ids]
                                            [--subscription]
                                            [--workspace-name]
                                            [--yes]

Examples

Delete a synapse managed private endpoints.

az synapse managed-private-endpoints delete --workspace-name testsynapseworkspace \
  --pe-name testendpointname

Required Parameters

--pe-name

The managed private endpoint name.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--workspace-name

The workspace name.

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
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.

--verbose

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

Property Value
Default value: False

az synapse managed-private-endpoints list

Edit

List synapse managed private endpoints in a workspace.

az synapse managed-private-endpoints list --workspace-name

Examples

List a synapse managed private endpoints.

az synapse managed-private-endpoints list --workspace-name testsynapseworkspace

Required Parameters

--workspace-name

The workspace name.

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 managed-private-endpoints show

Edit

Get a synapse managed private endpoints.

az synapse managed-private-endpoints show --pe-name
                                          [--ids]
                                          [--subscription]
                                          [--workspace-name]

Examples

Get a synapse managed private endpoints.

az synapse managed-private-endpoints show --workspace-name testsynapseworkspace \
  --pe-name testendpointname

Required Parameters

--pe-name

The managed private endpoint name.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--workspace-name

The workspace name.

Property Value
Parameter group: Resource Id Arguments
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.

--verbose

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

Property Value
Default value: False