az cognitiveservices account network-rule

Manage network rules.

Commands

Name	Description	Type	Status
az cognitiveservices account network-rule add	Add a network rule.	Core	GA
az cognitiveservices account network-rule list	List network rules.	Core	GA
az cognitiveservices account network-rule remove	Remove a network rule.	Core	GA

az cognitiveservices account network-rule add

Edit

Add a network rule.

Rules can be created for an IPv4 address, address range (CIDR format), or a virtual network subnet.

az cognitiveservices account network-rule add --name
                                              --resource-group
                                              [--ip-address]
                                              [--subnet]
                                              [--vnet-name]

Examples

Create a rule to allow a specific address-range.

az cognitiveservices account network-rule add -g myRg --name MyAccount --ip-address 23.45.1.0/24

Create a rule to allow access for a subnet.

az cognitiveservices account network-rule add -g myRg --name MyAccount --vnet myvnet --subnet mysubnet

Required Parameters

--name -n

Cognitive service account name.

--resource-group -g

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.

--ip-address

IPv4 address or CIDR range.

--subnet

Name or ID of subnet. If name is supplied, --vnet-name must be supplied.

--vnet-name

Name of a virtual network.

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 cognitiveservices account network-rule list

Edit

List network rules.

az cognitiveservices account network-rule list --name
                                               --resource-group

Examples

List network rules.

az cognitiveservices account network-rule list --name MyAccount --resource-group MyResourceGroup

Required Parameters

--name -n

Cognitive service account 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.

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 cognitiveservices account network-rule remove

Edit

Remove a network rule.

az cognitiveservices account network-rule remove --name
                                                 --resource-group
                                                 [--ip-address]
                                                 [--subnet]
                                                 [--vnet-name]

Examples

Remove a network rule.

az cognitiveservices account network-rule remove --name MyAccount --resource-group MyResourceGroup --subnet mysubnet

Remove a network rule.

az cognitiveservices account network-rule remove --name MyAccount --ip-address 23.45.1.0/24 --resource-group MyResourceGroup

Required Parameters

--name -n

Cognitive service account name.

--resource-group -g

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.

--ip-address

IPv4 address or CIDR range.

--subnet

Name or ID of subnet. If name is supplied, --vnet-name must be supplied.

--vnet-name

Name of a virtual network.

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