Share via

az apic service

  • 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 service . Obtenga más información sobre las extensiones.

Administración de una instancia de servicio del Centro de API de Azure.

Comandos

Nombre Description Tipo Estado
az apic service create

Crea una instancia o actualiza una instancia existente de un servicio del Centro de API de Azure.

 Extensión GA
az apic service delete

Elimina una instancia de un servicio del Centro de API de Azure.

 Extensión GA
az apic service import-from-apim

Importa las API desde una instancia del servicio Azure API Management.

 Extensión GA
az apic service list

Enumera los servicios del Centro de API de Azure dentro de una suscripción de Azure.

 Extensión GA
az apic service show

Mostrar detalles de una instancia de servicio del Centro de API de Azure.

 Extensión GA
az apic service update

Actualice una instancia de un servicio del Centro de API de Azure.

 Extensión GA

az apic service create

Crea una instancia o actualiza una instancia existente de un servicio del Centro de API de Azure.

az apic service create --name
                       --resource-group
                       [--identity]
                       [--location]
                       [--tags]

Ejemplos

Ejemplo 1 de creación de servicio

az apic service create -g contoso-resources -s contoso -l eastus

Ejemplo 2 de creación de servicio

az apic service create --resource-group contoso-resources --name contoso --location eastus

Parámetros requeridos

--name --service --service-name -s

Nombre del servicio del Centro de API.

--resource-group -g

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

Parámetros opcionales

--identity

Identidades de servicio administradas asignadas a este recurso. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

--location -l

Ubicación geográfica donde reside el recurso Cuando no se especifica, se usará la ubicación del grupo de recursos.

--tags

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

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 service delete

Elimina una instancia de un servicio del Centro de API de Azure.

az apic service delete [--ids]
                       [--name]
                       [--resource-group]
                       [--subscription]
                       [--yes]

Ejemplos

Eliminar servicio

az apic service delete -s contoso -g contoso-resources

Parámetros opcionales

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

--name --service --service-name -s

Nombre del servicio del Centro de API.

--resource-group -g

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

--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 service import-from-apim

Importa las API desde una instancia del servicio Azure API Management.

az apic service import-from-apim --source-resource-ids
                                 [--ids]
                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--resource-group]
                                 [--service]
                                 [--subscription]

Ejemplos

Importar desde APIM

az apic service import-from-apim -g api-center-test --service-name contosoeuap --source-resource-ids '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/servicegroup/providers/Microsoft.ApiManagement/service/contoso/apis/contosoapi'

Parámetros requeridos

--source-resource-ids

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

Parámetros opcionales

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

--no-wait

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

valores aceptados: 0, 1, f, false, n, no, t, true, y, yes
--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 Azure API Center.

--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 service list

Enumera los servicios del Centro de API de Azure dentro de una suscripción de Azure.

az apic service list [--max-items]
                     [--next-token]
                     [--resource-group]

Ejemplos

Enumeración de servicios en el grupo de recursos

az apic service list -g contoso-resources

Parámetros opcionales

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

--resource-group -g

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

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 service show

Mostrar detalles de una instancia de servicio del Centro de API de Azure.

az apic service show [--ids]
                     [--name]
                     [--resource-group]
                     [--subscription]

Ejemplos

Mostrar detalles del servicio

az apic service show -g contoso-resources -s contoso

Parámetros opcionales

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

--name --service --service-name -s

Nombre del servicio del Centro de API.

--resource-group -g

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

--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 service update

Actualice una instancia de un servicio del Centro de API de Azure.

az apic service update [--identity]
                       [--ids]
                       [--name]
                       [--resource-group]
                       [--subscription]
                       [--tags]

Ejemplos

Actualizar los detalles del servicio

az apic service update -g contoso-resources -s contoso

Parámetros opcionales

--identity

Identidades de servicio administradas asignadas a este recurso. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

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

--name --service --service-name -s

Nombre del servicio Azure API Center.

--resource-group -g

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

--subscription

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

--tags

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

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.