Comparteix a través de

az apim api versionset

  • Referencia

Administración del conjunto de versiones de la API de Azure API Management.

Comandos

Nombre Description Tipo Estado
az apim api versionset create

Crea un conjunto de versiones de API.

 Núcleo GA
az apim api versionset delete

Elimina un conjunto de versiones de API específico.

 Núcleo GA
az apim api versionset list

Enumera una colección de conjuntos de versiones de API en la instancia de servicio especificada.

 Núcleo GA
az apim api versionset show

Obtiene los detalles del conjunto de versiones de api especificado por su identificador.

 Núcleo GA
az apim api versionset update

Actualiza los detalles del conjunto de versiones de API especificado por su identificador.

 Núcleo GA

az apim api versionset create

Editar

Crea un conjunto de versiones de API.

az apim api versionset create --display-name
                              --resource-group
                              --service-name
                              --versioning-scheme
                              [--description]
                              [--if-match]
                              [--version-header-name]
                              [--version-query-name]
                              [--version-set-id]

Ejemplos

Crea un conjunto de versiones de API con el esquema de versión como encabezado.

az apim api versionset create --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --display-name MyDisplayName --versioning-scheme "Header" --description MyDescription --version-header-name MyHeaderName

Crea un conjunto de versiones de API con el esquema de versión como consulta.

az apim api versionset create --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --display-name MyDisplayName --versioning-scheme "Query" --description MyDescription --version-query-name MyQueryName

Parámetros requeridos

--display-name

Obligatorio. Nombre del conjunto de versiones de API.

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

--versioning-scheme

Obligatorio. Valor que determina dónde se ubicará el identificador de la versión de la API en una solicitud HTTP. Entre los valores posibles se incluyen: 'Segment', 'Query', 'Header'.

Parámetros opcionales

--description

Descripción del conjunto de versiones de API.

--if-match

ETag de la entidad.

--version-header-name

Nombre del parámetro de encabezado HTTP que indica la versión de API si versioningScheme está establecido en header.

--version-query-name

Nombre del parámetro de consulta que indica la versión de API si versioningScheme está establecido en query.

--version-set-id

Identificador de recurso para apiVersionSet relacionado.

Parámetros globales
--debug

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

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--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.

az apim api versionset delete

Editar

Elimina un conjunto de versiones de API específico.

az apim api versionset delete --resource-group
                              --service-name
                              --version-set-id
                              [--if-match]

Ejemplos

Elimina un conjunto de versiones de API específico.

az apim api versionset delete --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId

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.

--version-set-id

Identificador de recurso para apiVersionSet relacionado.

Parámetros opcionales

--if-match

ETag de la entidad.

Parámetros globales
--debug

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

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--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.

az apim api versionset list

Editar

Enumera una colección de conjuntos de versiones de API en la instancia de servicio especificada.

az apim api versionset list --resource-group
                            --service-name

Ejemplos

Enumera una colección de conjuntos de versiones de API en la instancia de servicio especificada.

az apim api versionset list --resource-group MyResourceGroup --service-name MyServiceName

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.

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--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.

az apim api versionset show

Editar

Obtiene los detalles del conjunto de versiones de api especificado por su identificador.

az apim api versionset show --resource-group
                            --service-name
                            --version-set-id

Ejemplos

Obtiene los detalles del conjunto de versiones de api especificado por su identificador.

az apim api versionset show --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId

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.

--version-set-id

Identificador de recurso para apiVersionSet relacionado.

Parámetros globales
--debug

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

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--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.

az apim api versionset update

Editar

Actualiza los detalles del conjunto de versiones de API especificado por su identificador.

az apim api versionset update --resource-group
                              --service-name
                              --version-set-id
                              [--add]
                              [--description]
                              [--display-name]
                              [--force-string]
                              [--if-match]
                              [--remove]
                              [--set]
                              [--version-header-name]
                              [--version-query-name]
                              [--versioning-scheme]

Ejemplos

Actualiza la descripción, nombre para mostrar del conjunto de versiones de api especificado por su identificador.

az apim api versionset update --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --display-name MyNewDisplayName --description MyNewDescription

Actualiza el esquema de versión del conjunto de versiones de api especificado por su identificador.

az apim api versionset update --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --versioning-scheme "Query" --version-query-name MyNewQueryName

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.

--version-set-id

Identificador de recurso para apiVersionSet relacionado.

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

Valor predeterminado: []
--description

Descripción del conjunto de versiones de API.

--display-name

Obligatorio. Nombre del conjunto de versiones de API.

--force-string

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

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.

Valor predeterminado: []
--set

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

Valor predeterminado: []
--version-header-name

Nombre del parámetro de encabezado HTTP que indica la versión de API si versioningScheme está establecido en header.

--version-query-name

Nombre del parámetro de consulta que indica la versión de API si versioningScheme está establecido en query.

--versioning-scheme

Obligatorio. Valor que determina dónde se ubicará el identificador de la versión de la API en una solicitud HTTP. Entre los valores posibles se incluyen: 'Segment', 'Query', 'Header'.

Parámetros globales
--debug

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

--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--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.