az datafactory managed-private-endpoint

  • Preview
  • Reference

Note

This reference is part of the datafactory extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az datafactory managed-private-endpoint command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage managed private endpoint with datafactory.

Commands

Name Description Type Status
az datafactory managed-private-endpoint create

Create a managed private endpoint.

 Extension Preview
az datafactory managed-private-endpoint delete

Deletes a managed private endpoint.

 Extension Preview
az datafactory managed-private-endpoint list

Lists managed private endpoints.

 Extension Preview
az datafactory managed-private-endpoint show

Gets a managed private endpoint.

 Extension Preview
az datafactory managed-private-endpoint update

Update a managed private endpoint.

 Extension Preview

az datafactory managed-private-endpoint create

Preview

Command group 'datafactory managed-private-endpoint' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a managed private endpoint.

az datafactory managed-private-endpoint create --factory-name
                                               --managed-private-endpoint-name
                                               --managed-virtual-network-name
                                               --resource-group
                                               [--fqdns]
                                               [--group-id]
                                               [--if-match]
                                               [--private-link]

Examples

ManagedPrivateEndpoints_Create

az datafactory managed-private-endpoint create --factory-name "exampleFactoryName" --group-id "blob" --private-link-resource-id "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Storage/storageAccounts/exampleBlobStorage" --name "exampleManagedPrivateEndpointName" --managed-virtual-network-name "exampleManagedVirtualNetworkName" --resource-group "exampleResourceGroup"

Required Parameters

--factory-name

The factory name.

--managed-private-endpoint-name --name -n

Managed private endpoint name.

--managed-virtual-network-name --mvnet-name

Managed virtual network name.

--resource-group -g

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

Optional Parameters

--fqdns

Fully qualified domain names.

--group-id

The groupId to which the managed private endpoint is created.

--if-match

ETag of the managed private endpoint entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

--private-link --private-link-resource-id

The ARM resource ID of the resource to which the managed private endpoint is created.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az datafactory managed-private-endpoint delete

Preview

Command group 'datafactory managed-private-endpoint' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Deletes a managed private endpoint.

az datafactory managed-private-endpoint delete [--factory-name]
                                               [--ids]
                                               [--managed-private-endpoint-name]
                                               [--managed-virtual-network-name]
                                               [--resource-group]
                                               [--subscription]
                                               [--yes]

Examples

ManagedPrivateEndpoints_Delete

az datafactory managed-private-endpoint delete --factory-name "exampleFactoryName" --name "exampleManagedPrivateEndpointName" --managed-virtual-network-name "exampleManagedVirtualNetworkName" --resource-group "exampleResourceGroup"

Optional Parameters

--factory-name

The factory name.

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

--managed-private-endpoint-name --name -n

Managed private endpoint name.

--managed-virtual-network-name --mvnet-name

Managed virtual network name.

--resource-group -g

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

--subscription

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

--yes -y

Do not prompt for confirmation.

default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az datafactory managed-private-endpoint list

Preview

Command group 'datafactory managed-private-endpoint' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Lists managed private endpoints.

az datafactory managed-private-endpoint list --factory-name
                                             --managed-virtual-network-name
                                             --resource-group

Examples

ManagedPrivateEndpoints_ListByFactory

az datafactory managed-private-endpoint list --factory-name "exampleFactoryName" --managed-virtual-network-name "exampleManagedVirtualNetworkName" --resource-group "exampleResourceGroup"

Required Parameters

--factory-name

The factory name.

--managed-virtual-network-name --mvnet-name

Managed virtual network name.

--resource-group -g

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az datafactory managed-private-endpoint show

Preview

Command group 'datafactory managed-private-endpoint' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Gets a managed private endpoint.

az datafactory managed-private-endpoint show [--factory-name]
                                             [--ids]
                                             [--if-none-match]
                                             [--managed-private-endpoint-name]
                                             [--managed-virtual-network-name]
                                             [--resource-group]
                                             [--subscription]

Examples

ManagedPrivateEndpoints_Get

az datafactory managed-private-endpoint show --factory-name "exampleFactoryName" --name "exampleManagedPrivateEndpointName" --managed-virtual-network-name "exampleManagedVirtualNetworkName" --resource-group "exampleResourceGroup"

Optional Parameters

--factory-name

The factory name.

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

--if-none-match

ETag of the managed private endpoint entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.

--managed-private-endpoint-name --name -n

Managed private endpoint name.

--managed-virtual-network-name --mvnet-name

Managed virtual network name.

--resource-group -g

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

--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az datafactory managed-private-endpoint update

Preview

Command group 'datafactory managed-private-endpoint' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a managed private endpoint.

az datafactory managed-private-endpoint update [--add]
                                               [--factory-name]
                                               [--force-string]
                                               [--fqdns]
                                               [--group-id]
                                               [--ids]
                                               [--if-match]
                                               [--if-none-match]
                                               [--managed-private-endpoint-name]
                                               [--managed-virtual-network-name]
                                               [--private-link]
                                               [--remove]
                                               [--resource-group]
                                               [--set]
                                               [--subscription]

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

default value: []
--factory-name

The factory name.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

default value: False
--fqdns

Fully qualified domain names.

--group-id

The groupId to which the managed private endpoint is created.

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

--if-match

ETag of the managed private endpoint entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

--if-none-match

ETag of the managed private endpoint entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. Default value is None.

--managed-private-endpoint-name --name -n

Managed private endpoint name.

--managed-virtual-network-name --mvnet-name

Managed virtual network name.

--private-link --private-link-resource-id

The ARM resource ID of the resource to which the managed private endpoint is created.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

default value: []
--resource-group -g

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

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

default value: []
--subscription

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.