Share via

az ml workspace outbound-rule

  • Reference

Note

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

Manage outbound rules for the managed network of an Azure ML workspace.

An Azure ML workspace is the top-level resource for Azure Machine Learning. This command group is used to perform operations on the outbound rules of the workspace managed network.

Commands

Name Description Type Status
az ml workspace outbound-rule list

List all the managed network outbound rules for a workspace.

 Extension GA
az ml workspace outbound-rule remove

Remove an outbound rule from the managed network for a workspace.

 Extension GA
az ml workspace outbound-rule set

Add or update an outbound rule in the managed network for a workspace.

 Extension GA
az ml workspace outbound-rule show

Show details for a managed network outbound rule for a workspace.

 Extension GA

az ml workspace outbound-rule list

List all the managed network outbound rules for a workspace.

az ml workspace outbound-rule list --resource-group
                                   --workspace-name

Required Parameters

--resource-group -g

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

--workspace-name -w

Name of the Azure ML workspace. You can configure the default workspace using az configure --defaults workspace=<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 ml workspace outbound-rule remove

Remove an outbound rule from the managed network for a workspace.

az ml workspace outbound-rule remove --resource-group
                                     --rule
                                     --workspace-name
                                     [--no-wait]
                                     [--yes]

Required Parameters

--resource-group -g

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

--rule

Name of the Outbound Rule to remove.

--workspace-name -w

Name of the Azure ML workspace. You can configure the default workspace using az configure --defaults workspace=<name>.

Optional Parameters

--no-wait

Do not wait for the long-running-operation to finish. Default is False.

Default value: False
--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 ml workspace outbound-rule set

Add or update an outbound rule in the managed network for a workspace.

This command can be used to specify an outbound rule for the managed network of the workspace. The needed parameters are defined by --type. For --type service_tag use --service-tag, --port-ranges, --protocol, [Optional] --address-prefixes For --type fqdn use --destination For --type private_endpoint use --service-resource-id, --subresource-target, [Optional] --spark-enabled, [Optional] --fqdns.

az ml workspace outbound-rule set --resource-group
                                  --rule
                                  --type
                                  --workspace-name
                                  [--address-prefixes]
                                  [--destination]
                                  [--fqdns]
                                  [--no-wait]
                                  [--port-ranges]
                                  [--protocol]
                                  [--service-resource-id]
                                  [--service-tag]
                                  [--spark-enabled]
                                  [--subresource-target]

Required Parameters

--resource-group -g

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

--rule

Name of the outbound Rule object to set.

--type

The type of outbound rule to specify. Can be fqdn, private_endpoint, service_tag.

--workspace-name -w

Name of the Azure ML workspace. You can configure the default workspace using az configure --defaults workspace=<name>.

Optional Parameters

--address-prefixes

For ServiceTag rules: [Optional] list of CIDR prefixes or IP ranges, when provided, --service-tag will be ignored and --address-prefixes will be used instead.

--destination

For FQDN rules: Fully qualified domain name to which outbound connections are allowed, required for fqdn outbound rule.

--fqdns

For PrivateEndpoint rules: [Optional] A comma-separated list of FQDNs particular to the Private Endpoint resource creation. For application gateway PEs, this is the FQDN which will resolve to the private IP of the application gateway PE inside the workspace's managed network. For example: "contoso.com,contoso2.com".

--no-wait

Do not wait for the long-running-operation to finish. Default is False.

Default value: False
--port-ranges

For ServiceTag rules: A comma-separated list of single ports and/or range of ports, such as "80,1024-65535" that traffics are allowed, required for service_tag outbound rule.

--protocol

For ServiceTag rules: Allowed transport protocol, can be TCP, UDP, ICMP or * for all supported protocols, required for service_tag outbound rule.

--service-resource-id

For PrivateEndpoint rules: The resource URI of the root service that supports creation of the private link, required for private_endpoint outbound rule.

--service-tag

For ServiceTag rules: Service Tag of an Azure service that maps to predefined IP addresses for its service endpoints, required for service_tag outbound rule.

--spark-enabled

For PrivateEndpoint rules: Indicates if the private endpoint can be used for Spark jobs, default is false, required for private_endpoint outbound rule.

--subresource-target

For PrivateEndpoint rules: The target endpoint of the subresource of the service, required for private_endpoint outbound rule.

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 ml workspace outbound-rule show

Show details for a managed network outbound rule for a workspace.

az ml workspace outbound-rule show --resource-group
                                   --rule
                                   --workspace-name

Required Parameters

--resource-group -g

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

--rule

Name of the Outbound Rule to show.

--workspace-name -w

Name of the Azure ML workspace. You can configure the default workspace using az configure --defaults workspace=<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.