Share via

az apic api deployment

  • Referencia

Nota:

Esta referencia forma parte de la extensión apic-extension para la CLI de Azure (versión 2.57.0 o posterior). La extensión instalará automáticamente la primera vez que ejecute un comando az apic api deployment . Obtenga más información sobre las extensiones.

Comandos para administrar implementaciones de API en el Centro de API.

Comandos

Nombre Description Tipo Estado
az apic api deployment create

Cree una nueva implementación de API o actualice una implementación de API existente.

 Extensión GA
az apic api deployment delete

Eliminar implementación de API.

 Extensión GA
az apic api deployment list

Enumeración de una colección de implementaciones de API.

 Extensión GA
az apic api deployment show

Obtenga detalles de la implementación de la API.

 Extensión GA
az apic api deployment update

Actualice la implementación de API existente.

 Extensión GA

az apic api deployment create

Cree una nueva implementación de API o actualice una implementación de API existente.

az apic api deployment create --api-id
                              --deployment-id
                              --resource-group
                              --service
                              [--custom-properties]
                              [--definition-id]
                              [--description]
                              [--environment-id]
                              [--server]
                              [--state {active, inactive}]
                              [--title]

Ejemplos

Creación de una implementación

az apic api deployment create -g api-center-test -s contoso --deployment-id production --title "Production deployment" --description "Public cloud production deployment." --api-id echo-api --environment-id "/workspaces/default/environments/production" --definition-id "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi" --server '{"runtimeUri":["https://example.com"]}'

Parámetros requeridos

--api-id

Identificador de la API.

--deployment-id

Identificador de la implementación de la API.

--resource-group -g

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

--service --service-name -s

Nombre del servicio del Centro de API.

Parámetros opcionales

--custom-properties

Metadatos personalizados definidos para las entidades del catálogo de API. Admite json-file y yaml-file.

--definition-id

Identificador de recurso de definición con ámbito del centro de API.

--description

Descripción de la implementación.

--environment-id

Identificador de recurso de entorno con ámbito del centro de API.

--server

Server Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

--state

Estado de la implementación de la API.

valores aceptados: active, inactive
--title

Título de implementación.

Parámetros globales
--debug

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

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

az apic api deployment delete

Eliminar implementación de API.

az apic api deployment delete [--api-id]
                              [--deployment-id]
                              [--ids]
                              [--resource-group]
                              [--service]
                              [--subscription]
                              [--yes]

Ejemplos

Eliminación de la implementación de API

az apic api deployment delete -g api-center-test -s contoso --deployment-id production --api-id echo-api

Parámetros opcionales

--api-id

Identificador de la API.

--deployment-id

Identificador de la implementación de la API.

--ids

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--resource-group -g

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

--service --service-name -s

Nombre del servicio del Centro de API.

--subscription

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

--yes -y

No solicita confirmación.

valor predeterminado: False
Parámetros globales
--debug

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

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

az apic api deployment list

Enumeración de una colección de implementaciones de API.

az apic api deployment list --api-id
                            --resource-group
                            --service
                            [--filter]
                            [--max-items]
                            [--next-token]

Ejemplos

Enumerar implementaciones de API

az apic api deployment list -g api-center-test -s contoso --api-id echo-api

Parámetros requeridos

--api-id

Identificador de la API.

--resource-group -g

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

--service --service-name -s

Nombre del servicio del Centro de API.

Parámetros opcionales

--filter

Parámetro de filtro OData.

--max-items

Número total de elementos que se van a devolver en la salida del comando. Si el número total de elementos disponibles es mayor que el valor especificado, se proporciona un token en la salida del comando. Para reanudar la paginación, proporcione el valor del token en --next-token el argumento de un comando posterior.

--next-token

Token para especificar dónde iniciar la paginación. Este es el valor del token de una respuesta truncada anteriormente.

Parámetros globales
--debug

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

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

az apic api deployment show

Obtenga detalles de la implementación de la API.

az apic api deployment show [--api-id]
                            [--deployment-id]
                            [--ids]
                            [--resource-group]
                            [--service]
                            [--subscription]

Ejemplos

Mostrar detalles de implementación de API

az apic api deployment show -g api-center-test -s contoso --deployment-id production --api-id echo-api

Parámetros opcionales

--api-id

Identificador de la API.

--deployment-id

Identificador de la implementación de la API.

--ids

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--resource-group -g

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

--service --service-name -s

Nombre del servicio del Centro de API.

--subscription

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

Parámetros globales
--debug

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

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.

az apic api deployment update

Actualice la implementación de API existente.

az apic api deployment update [--add]
                              [--api-id]
                              [--custom-properties]
                              [--definition-id]
                              [--deployment-id]
                              [--description]
                              [--environment-id]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--ids]
                              [--remove]
                              [--resource-group]
                              [--server]
                              [--service]
                              [--set]
                              [--state {active, inactive}]
                              [--subscription]
                              [--title]

Ejemplos

Actualización de la implementación de API

az apic api deployment update -g api-center-test -s contoso --deployment-id production --title "Production deployment" --api-id echo-api

Parámetros opcionales

--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 o JSON string>.

--api-id

Identificador de la API.

--custom-properties

Metadatos personalizados definidos para las entidades del catálogo de API. Admite json-file y yaml-file.

--definition-id

Identificador de recurso de definición con ámbito de servicio.

--deployment-id

Identificador de la implementación de la API.

--description

Descripción de la implementación.

--environment-id

Identificador de recurso de entorno con ámbito de servicio.

--force-string

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

valores aceptados: 0, 1, f, false, n, no, t, true, y, yes
--ids

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--remove

Quite una propiedad o un elemento de una lista. Ejemplo: --remove property.list OR --remove propertyToRemove.

--resource-group -g

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

--server

Server Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

--service --service-name -s

Nombre del servicio del Centro de API.

--set

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

--state

Estado de la implementación de la API.

valores aceptados: active, inactive
--subscription

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

--title

Título.

Parámetros globales
--debug

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

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--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 de registro. Use --debug para obtener registros de depuración completos.