Share via

az nginx deployment api-key

  • Preview
  • Reference

Note

This reference is part of the nginx extension for the Azure CLI (version 2.68.0 or higher). The extension will automatically install the first time you run an az nginx deployment api-key command. Learn more about extensions.

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

Managing Nginxaas deployment API Keys.

Commands

Name Description Type Status
az nginx deployment api-key create

Create an API Key for the Nginx deployment in order to access the dataplane API endpoint.

 Extension Preview
az nginx deployment api-key delete

Delete API key for Nginx deployment.

 Extension Preview
az nginx deployment api-key list

List all API Keys of the given Nginx deployment.

 Extension Preview
az nginx deployment api-key show

Get the specified API Key of the given Nginx deployment.

 Extension Preview
az nginx deployment api-key update

Update an API Key for the Nginx deployment in order to access the dataplane API endpoint.

 Extension Preview

az nginx deployment api-key create

Preview

Command group 'az nginx deployment api-key' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create an API Key for the Nginx deployment in order to access the dataplane API endpoint.

az nginx deployment api-key create --api-key-name
                                   --deployment-name
                                   --resource-group
                                   [--end-date-time]
                                   [--secret-text]

Required Parameters

--api-key-name --name -n

The resource name of the API key.

--deployment-name

The name of targeted NGINX deployment.

--resource-group -g

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

Optional Parameters

--end-date-time

The time after which this Dataplane API Key is no longer valid.

--secret-text

Secret text to be used as a Dataplane API Key. This is a write only property that can never be read back, but the first three characters will be returned in the 'hint' property. If value is blank it's asked from the tty.

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 nginx deployment api-key delete

Preview

Command group 'az nginx deployment api-key' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete API key for Nginx deployment.

az nginx deployment api-key delete [--api-key-name]
                                   [--deployment-name]
                                   [--ids]
                                   [--resource-group]
                                   [--subscription]
                                   [--yes]

Optional Parameters

--api-key-name --name -n

The resource name of the API key.

--deployment-name

The name of targeted NGINX deployment.

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

--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 nginx deployment api-key list

Preview

Command group 'az nginx deployment api-key' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all API Keys of the given Nginx deployment.

az nginx deployment api-key list --deployment-name
                                 --resource-group
                                 [--max-items]
                                 [--next-token]

Required Parameters

--deployment-name

The name of targeted NGINX deployment.

--resource-group -g

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

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

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 nginx deployment api-key show

Preview

Command group 'az nginx deployment api-key' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get the specified API Key of the given Nginx deployment.

az nginx deployment api-key show [--api-key-name]
                                 [--deployment-name]
                                 [--ids]
                                 [--resource-group]
                                 [--subscription]

Optional Parameters

--api-key-name --name -n

The resource name of the API key.

--deployment-name

The name of targeted NGINX deployment.

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

--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 nginx deployment api-key update

Preview

Command group 'az nginx deployment api-key' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update an API Key for the Nginx deployment in order to access the dataplane API endpoint.

az nginx deployment api-key update [--add]
                                   [--api-key-name]
                                   [--deployment-name]
                                   [--end-date-time]
                                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--ids]
                                   [--remove]
                                   [--resource-group]
                                   [--secret-text]
                                   [--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>.

--api-key-name --name -n

The resource name of the API key.

--deployment-name

The name of targeted NGINX deployment.

--end-date-time

The time after which this Dataplane API Key is no longer valid.

--force-string

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

--remove

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

--resource-group -g

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

--secret-text

Secret text to be used as a Dataplane API Key. This is a write only property that can never be read back, but the first three characters will be returned in the 'hint' property. If value is blank it's asked from the tty.

--set

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