Share via

az datafactory managed-virtual-network

  • 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-virtual-network 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 virtual network with datafactory.

Commands

Name Description Type Status
az datafactory managed-virtual-network create

Create a managed Virtual Network.

 Extension Preview
az datafactory managed-virtual-network list

Lists managed Virtual Networks.

 Extension Preview
az datafactory managed-virtual-network show

Gets a managed Virtual Network.

 Extension Preview
az datafactory managed-virtual-network update

Update a managed Virtual Network.

 Extension Preview

az datafactory managed-virtual-network create

Preview

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

Create a managed Virtual Network.

az datafactory managed-virtual-network create --factory-name
                                              --managed-virtual-network-name
                                              --resource-group
                                              [--if-match]

Examples

ManagedVirtualNetworks_Create

az datafactory managed-virtual-network create --factory-name "exampleFactoryName" --name "exampleManagedVirtualNetworkName" --resource-group "exampleResourceGroup"

Required Parameters

--factory-name

The factory name.

--managed-virtual-network-name --name -n

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

--if-match

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

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-virtual-network list

Preview

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

Lists managed Virtual Networks.

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

Examples

ManagedVirtualNetworks_ListByFactory

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

Required Parameters

--factory-name

The factory 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-virtual-network show

Preview

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

Gets a managed Virtual Network.

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

Examples

ManagedVirtualNetworks_Get

az datafactory managed-virtual-network show --factory-name "exampleFactoryName" --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 Virtual Network 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-virtual-network-name --name -n

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-virtual-network update

Preview

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

Update a managed Virtual Network.

az datafactory managed-virtual-network update [--add]
                                              [--factory-name]
                                              [--force-string]
                                              [--ids]
                                              [--if-match]
                                              [--if-none-match]
                                              [--managed-virtual-network-name]
                                              [--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
--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 Virtual Network 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 Virtual Network 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-virtual-network-name --name -n

Managed virtual network name.

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