Compartir a través de


az apim nv

Administrar valores con nombre de Azure API Management.

Comandos

Nombre Description Tipo Estado
az apim nv create

Cree un valor con nombre de API Management.

Core GA
az apim nv delete

Elimine un valor con nombre de API Management.

Core GA
az apim nv list

Enumerar valores con nombre de API Management.

Core GA
az apim nv show

Muestra los detalles de un valor con nombre de API Management.

Core GA
az apim nv show-secret

Obtiene el secreto de un valor con nombre de API Management.

Core GA
az apim nv update

Actualice un valor con nombre de API Management.

Core GA
az apim nv wait

Coloque la CLI en un estado de espera hasta que se cumpla una condición de un valor con nombre apim.

Core GA

az apim nv create

Cree un valor con nombre de API Management.

az apim nv create --display-name
                  --named-value-id
                  --resource-group
                  --service-name
                  [--if-match]
                  [--no-wait]
                  [--secret {false, true}]
                  [--tags]
                  [--value]

Ejemplos

Cree un valor con nombre.

az apim nv create --service-name MyApim -g MyResourceGroup --named-value-id MyNamedValue --display-name 'My Named Value' --value 'foo'

Parámetros requeridos

--display-name

Nombre para mostrar del valor con nombre.

--named-value-id

Nombre único para el valor con nombre que se va a crear.

Debe ser único en la instancia actual del servicio API Management.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--service-name -n

Nombre de la instancia del servicio API Management.

Parámetros opcionales

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--if-match

ETag de la entidad.

--no-wait

No espere a que finalice la operación de ejecución prolongada.

Propiedad Valor
Valor predeterminado: False
--secret

Determina si el valor es un secreto y debe cifrarse o no. El valor predeterminado es false.

Propiedad Valor
Valor predeterminado: False
Valores aceptados: false, true
--tags

Etiquetas separadas por espacios: key[=value] [key[=value] ...]. Use "" para borrar las etiquetas existentes.

--value

Valor del valor con nombre.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Output format.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az apim nv delete

Elimine un valor con nombre de API Management.

az apim nv delete --named-value-id
                  --resource-group
                  --service-name
                  [--yes]

Parámetros requeridos

--named-value-id

Identificador de NamedValue.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--service-name -n

Nombre de la instancia del servicio API Management.

Parámetros opcionales

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--yes -y

No solicita confirmación.

Propiedad Valor
Valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Output format.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az apim nv list

Enumerar valores con nombre de API Management.

az apim nv list --resource-group
                --service-name

Parámetros requeridos

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--service-name -n

Nombre de la instancia del servicio API Management.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Output format.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az apim nv show

Muestra los detalles de un valor con nombre de API Management.

az apim nv show --named-value-id
                --resource-group
                --service-name

Parámetros requeridos

--named-value-id

Identificador de NamedValue.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--service-name -n

Nombre de la instancia del servicio API Management.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Output format.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az apim nv show-secret

Obtiene el secreto de un valor con nombre de API Management.

az apim nv show-secret --named-value-id
                       --resource-group
                       --service-name

Parámetros requeridos

--named-value-id

Identificador de NamedValue.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--service-name -n

Nombre de la instancia del servicio API Management.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Output format.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az apim nv update

Actualice un valor con nombre de API Management.

az apim nv update --named-value-id
                  --resource-group
                  --service-name
                  [--add]
                  [--force-string]
                  [--if-match]
                  [--remove]
                  [--secret {false, true}]
                  [--set]
                  [--tags]
                  [--value]

Ejemplos

Cree una API básica.

az apim nv update --service-name MyApim -g MyResourceGroup --named-value-id MyNamedValue --value foo

Parámetros requeridos

--named-value-id

Nombre único de la API que se va a crear.

Debe ser único en la instancia actual del servicio API Management.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--service-name -n

Nombre de la instancia del servicio API Management.

Parámetros opcionales

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

Agregue un objeto a una lista de objetos especificando una ruta de acceso y pares clave-valor. Ejemplo: --add property.listProperty <key=value, string or JSON string>.

Propiedad Valor
Parameter group: Generic Update Arguments
Valor predeterminado: []
--force-string

Al usar 'set' o 'add', conserve los literales de cadena en lugar de intentar convertir en JSON.

Propiedad Valor
Parameter group: Generic Update Arguments
Valor predeterminado: False
--if-match

ETag de la entidad.

--remove

Quite una propiedad o un elemento de una lista. Ejemplo: --remove property.list <indexToRemove> O --remove propertyToRemove.

Propiedad Valor
Parameter group: Generic Update Arguments
Valor predeterminado: []
--secret

Determina si el valor es un secreto y debe cifrarse o no. El valor predeterminado es false.

Propiedad Valor
Valores aceptados: false, true
--set

Actualice un objeto especificando una ruta de acceso de propiedad y un valor que se va a establecer. Ejemplo: --set property1.property2=<value>.

Propiedad Valor
Parameter group: Generic Update Arguments
Valor predeterminado: []
--tags

Etiquetas separadas por espacios: key[=value] [key[=value] ...]. Use "" para borrar las etiquetas existentes.

--value

Valor del valor con nombre.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Output format.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az apim nv wait

Coloque la CLI en un estado de espera hasta que se cumpla una condición de un valor con nombre apim.

az apim nv wait --named-value-id
                --resource-group
                --service-name
                [--created]
                [--custom]
                [--deleted]
                [--exists]
                [--interval]
                [--timeout]
                [--updated]

Ejemplos

Coloque la CLI en un estado de espera hasta que se cumpla una condición de una API apim.

az apim nv wait --created --service-name MyApim -g MyResourceGroup --named-value-id MyNamedValue --resource-group MyResourceGroup

Parámetros requeridos

--named-value-id

Identificador de NamedValue.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--service-name -n

Nombre de la instancia del servicio API Management.

Parámetros opcionales

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

Espere hasta que se cree con "provisioningState" en "Succeeded".

Propiedad Valor
Parameter group: Wait Condition Arguments
Valor predeterminado: False
--custom

Espere hasta que la condición cumpla una consulta JMESPath personalizada. Por ejemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Propiedad Valor
Parameter group: Wait Condition Arguments
--deleted

Espere hasta que se elimine.

Propiedad Valor
Parameter group: Wait Condition Arguments
Valor predeterminado: False
--exists

Espere hasta que exista el recurso.

Propiedad Valor
Parameter group: Wait Condition Arguments
Valor predeterminado: False
--interval

Intervalo de sondeo en segundos.

Propiedad Valor
Parameter group: Wait Condition Arguments
Valor predeterminado: 30
--timeout

Espera máxima en segundos.

Propiedad Valor
Parameter group: Wait Condition Arguments
Valor predeterminado: 3600
--updated

Espere hasta que se actualice con provisioningState en "Succeeded".

Propiedad Valor
Parameter group: Wait Condition Arguments
Valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Output format.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False