Partilhar via

az apim api versionset

  • Referência

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

Editar

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

--display-name

Obrigatório. Nome do conjunto de versões da API.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--service-name -n

O nome da instância do serviço de Gerenciamento de API.

--versioning-scheme

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

--description

Descrição do conjunto de versões da API.

--if-match

ETag da Entidade.

--version-header-name

Nome do parâmetro de cabeçalho HTTP que indica a versão da API se versioningScheme estiver definido como header.

--version-query-name

Nome do parâmetro de consulta que indica a versão da API se versioningScheme estiver definido como query.

--version-set-id

Um identificador de recurso para o ApiVersionSet relacionado.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az apim api versionset delete

Editar

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

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--service-name -n

O nome da instância do serviço de Gerenciamento de API.

--version-set-id

Um identificador de recurso para o ApiVersionSet relacionado.

Parâmetros Opcionais

--if-match

ETag da Entidade.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az apim api versionset list

Editar

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

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--service-name -n

O nome da instância do serviço de Gerenciamento de API.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az apim api versionset show

Editar

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

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--service-name -n

O nome da instância do serviço de Gerenciamento de API.

--version-set-id

Um identificador de recurso para o ApiVersionSet relacionado.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az apim api versionset update

Editar

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

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--service-name -n

O nome da instância do serviço de Gerenciamento de API.

--version-set-id

Um identificador de recurso para o ApiVersionSet relacionado.

Parâmetros Opcionais

--add

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

valor predefinido: []
--description

Descrição do conjunto de versões da API.

--display-name

Obrigatório. Nome do conjunto de versões da API.

--force-string

Ao usar 'set' ou 'add', preserve literais de string em vez de tentar converter para JSON.

valor predefinido: False
--if-match

ETag da Entidade.

--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OR --remove propertyToRemove.

valor predefinido: []
--set

Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=<value>.

valor predefinido: []
--version-header-name

Nome do parâmetro de cabeçalho HTTP que indica a versão da API se versioningScheme estiver definido como header.

--version-query-name

Nome do parâmetro de consulta que indica a versão da API se versioningScheme estiver definido como query.

--versioning-scheme

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

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
valor predefinido: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.