az apim api versionset
Gerencie o conjunto de versões da API de Gerenciamento de API do Azure.
Comandos
Name | Description | Tipo | Estado |
---|---|---|---|
az apim api versionset create |
Cria um conjunto de versões da api. |
Principal | GA |
az apim api versionset delete |
Exclui o conjunto de versões da API específico. |
Principal | GA |
az apim api versionset list |
Lista uma coleção de conjuntos de versões de API na instância de serviço especificada. |
Principal | GA |
az apim api versionset show |
Obtém os detalhes do Api Version set especificado por seu identificador. |
Principal | GA |
az apim api versionset update |
Atualiza os detalhes do Api VersionSet especificado por seu identificador. |
Principal | GA |
az apim api versionset create
Cria um conjunto de versões da 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]
Exemplos
Cria um Conjunto de Versão da Api com o esquema de versão como cabeçalho.
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
Cria um Conjunto de Versão da Api com esquema de versão 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 Obrigatórios
Obrigatório. Nome do conjunto de versões da API.
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
O nome da instância do serviço de Gerenciamento de API.
Obrigatório. Um valor que determina onde o identificador de Versão da API estará localizado em uma solicitação HTTP. Os valores possíveis incluem: 'Segment', 'Query', 'Header'.
Parâmetros Opcionais
Descrição do conjunto de versões da API.
ETag da Entidade.
Nome do parâmetro de cabeçalho HTTP que indica a versão da API se versioningScheme estiver definido como header
.
Nome do parâmetro de consulta que indica a versão da API se versioningScheme estiver definido como query
.
Um identificador de recurso para o ApiVersionSet relacionado.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az apim api versionset delete
Exclui o conjunto de versões da API específico.
az apim api versionset delete --resource-group
--service-name
--version-set-id
[--if-match]
Exemplos
Exclui o conjunto de versões da API específico.
az apim api versionset delete --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId
Parâmetros Obrigatórios
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
O nome da instância do serviço de Gerenciamento de API.
Um identificador de recurso para o ApiVersionSet relacionado.
Parâmetros Opcionais
ETag da Entidade.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az apim api versionset list
Lista uma coleção de conjuntos de versões de API na instância de serviço especificada.
az apim api versionset list --resource-group
--service-name
Exemplos
Lista uma coleção de conjuntos de versões de API na instância de serviço especificada.
az apim api versionset list --resource-group MyResourceGroup --service-name MyServiceName
Parâmetros Obrigatórios
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
O nome da instância do serviço de Gerenciamento de API.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az apim api versionset show
Obtém os detalhes do Api Version set especificado por seu identificador.
az apim api versionset show --resource-group
--service-name
--version-set-id
Exemplos
Obtém os detalhes do Api Version set especificado por seu identificador.
az apim api versionset show --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId
Parâmetros Obrigatórios
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
O nome da instância do serviço de Gerenciamento de API.
Um identificador de recurso para o ApiVersionSet relacionado.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
az apim api versionset update
Atualiza os detalhes do Api VersionSet especificado por seu 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]
Exemplos
Atualiza a descrição, nome de exibição do Api VersionSet especificado por seu identificador.
az apim api versionset update --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --display-name MyNewDisplayName --description MyNewDescription
Atualiza o esquema de versão do Api VersionSet especificado por seu 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 Obrigatórios
o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>
.
O nome da instância do serviço de Gerenciamento de API.
Um identificador de recurso para o ApiVersionSet relacionado.
Parâmetros Opcionais
Adicione um objeto a uma lista de objetos especificando um caminho e pares de valor de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>
.
Descrição do conjunto de versões da API.
Obrigatório. Nome do conjunto de versões da API.
Ao usar 'set' ou 'add', preserve literais de string em vez de tentar converter para JSON.
ETag da Entidade.
Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=<value>
.
Nome do parâmetro de cabeçalho HTTP que indica a versão da API se versioningScheme estiver definido como header
.
Nome do parâmetro de consulta que indica a versão da API se versioningScheme estiver definido como query
.
Obrigatório. Um valor que determina onde o identificador de Versão da API estará localizado em uma solicitação HTTP. Os valores possíveis incluem: 'Segment', 'Query', 'Header'.
Parâmetros de Globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
Formato de saída.
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID
o .
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.