az cognitiveservices account managed-network outbound-rule
Command group 'cognitiveservices account managed-network' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Manage outbound rules for the managed network of an Azure Cognitive Services account.
Outbound rules control egress traffic from the managed network. Rules can be of type FQDN, PrivateEndpoint, or ServiceTag.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az cognitiveservices account managed-network outbound-rule bulk-set |
Bulk create or update outbound rules from a YAML or JSON file. |
Core | Preview |
| az cognitiveservices account managed-network outbound-rule list |
List all outbound rules for the managed network. |
Core | Preview |
| az cognitiveservices account managed-network outbound-rule remove |
Remove an outbound rule from the managed network. |
Core | Preview |
| az cognitiveservices account managed-network outbound-rule set |
Create or update a single outbound rule for the managed network. |
Core | Preview |
| az cognitiveservices account managed-network outbound-rule show |
Show details of an outbound rule. |
Core | Preview |
az cognitiveservices account managed-network outbound-rule bulk-set
Command group 'cognitiveservices account managed-network outbound-rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Bulk create or update outbound rules from a YAML or JSON file.
Reads outbound rules from a YAML or JSON file and creates or updates them in bulk.
az cognitiveservices account managed-network outbound-rule bulk-set --file
--name
--resource-group
[--acquire-policy-token]
[--change-reference]
[--managed-network-name]
Examples
Bulk set outbound rules from a YAML file.
az cognitiveservices account managed-network outbound-rule bulk-set --name my-account --resource-group my-resource-group --file rules.yaml
Required Parameters
Path to a YAML or JSON file containing outbound rules definition.
Cognitive service account name.
Name of resource group. You can configure the default group using az configure --defaults group=<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.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
Name of the managed network. Only "default" is supported.
| Property | Value |
|---|---|
| Default value: | default |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az cognitiveservices account managed-network outbound-rule list
Command group 'cognitiveservices account managed-network outbound-rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
List all outbound rules for the managed network.
az cognitiveservices account managed-network outbound-rule list --name
--resource-group
[--managed-network-name]
Examples
List all outbound rules.
az cognitiveservices account managed-network outbound-rule list --name my-account --resource-group my-resource-group
Required Parameters
Cognitive service account name.
Name of resource group. You can configure the default group using az configure --defaults group=<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.
Name of the managed network. Only "default" is supported.
| Property | Value |
|---|---|
| Default value: | default |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az cognitiveservices account managed-network outbound-rule remove
Command group 'cognitiveservices account managed-network outbound-rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Remove an outbound rule from the managed network.
az cognitiveservices account managed-network outbound-rule remove --name
--resource-group
--rule
[--acquire-policy-token]
[--change-reference]
[--managed-network-name]
[--yes]
Examples
Remove an outbound rule.
az cognitiveservices account managed-network outbound-rule remove --name my-account --resource-group my-resource-group --rule my-rule
Required Parameters
Cognitive service account name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name of the outbound rule.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
Name of the managed network. Only "default" is supported.
| Property | Value |
|---|---|
| Default value: | default |
Do not prompt for confirmation.
| Property | Value |
|---|---|
| Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az cognitiveservices account managed-network outbound-rule set
Command group 'cognitiveservices account managed-network outbound-rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Create or update a single outbound rule for the managed network.
Creates or updates an outbound rule of the specified type (FQDN, PrivateEndpoint, or ServiceTag).
az cognitiveservices account managed-network outbound-rule set --name
--resource-group
--rule
--type {fqdn, privateendpoint, servicetag}
[--acquire-policy-token]
[--category {Dependency, Recommended, Required, UserDefined}]
[--change-reference]
[--destination]
[--managed-network-name]
[--subresource-target]
Examples
Create an FQDN outbound rule.
az cognitiveservices account managed-network outbound-rule set --name my-account --resource-group my-resource-group --rule my-fqdn-rule --type fqdn --destination "*.example.com"
Create a ServiceTag outbound rule.
az cognitiveservices account managed-network outbound-rule set --name my-account --resource-group my-resource-group --rule my-servicetag-rule --type servicetag --category UserDefined --destination '{"serviceTag": "Storage", "protocol": "TCP", "portRanges": "443"}'
Create a PrivateEndpoint outbound rule.
az cognitiveservices account managed-network outbound-rule set --name my-account --resource-group my-resource-group --rule my-pe-rule --type privateendpoint --destination /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-rg/providers/Microsoft.Storage/storageAccounts/mystorageaccount --subresource-target blob
Required Parameters
Cognitive service account name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name of the outbound rule.
Type of the outbound rule.
| Property | Value |
|---|---|
| Accepted values: | fqdn, privateendpoint, servicetag |
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
Category of the outbound rule.
| Property | Value |
|---|---|
| Accepted values: | Dependency, Recommended, Required, UserDefined |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
Destination for the outbound rule. For FQDN rules, this is the FQDN string. For PrivateEndpoint rules, this is the service resource ID. For ServiceTag rules, provide a JSON string.
Name of the managed network. Only "default" is supported.
| Property | Value |
|---|---|
| Default value: | default |
Subresource target for PrivateEndpoint outbound rules (e.g. blob, table, queue, file, web, dfs).
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az cognitiveservices account managed-network outbound-rule show
Command group 'cognitiveservices account managed-network outbound-rule' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Show details of an outbound rule.
az cognitiveservices account managed-network outbound-rule show --name
--resource-group
--rule
[--managed-network-name]
Examples
Show an outbound rule.
az cognitiveservices account managed-network outbound-rule show --name my-account --resource-group my-resource-group --rule my-rule
Required Parameters
Cognitive service account name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name of the outbound rule.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Name of the managed network. Only "default" is supported.
| Property | Value |
|---|---|
| Default value: | default |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |