Compartilhar via

az apim api operation

  • Referência

Gerenciar operações de API de gerenciamento de API do Azure.

Comandos

Nome Description Tipo Status
az apim api operation create

Cria uma nova operação na API.

 Núcleo GA
az apim api operation delete

Exclui a operação especificada na API.

 Núcleo GA
az apim api operation list

Liste uma coleção das operações para a API especificada.

 Núcleo GA
az apim api operation show

Obtém os detalhes da Operação de API especificada por seu identificador.

 Núcleo GA
az apim api operation update

Atualiza os detalhes da operação na API especificada por seu identificador.

 Núcleo GA

az apim api operation create

Editar

Cria uma nova operação na API.

az apim api operation create --api-id
                             --display-name
                             --method
                             --resource-group
                             --service-name
                             --url-template
                             [--description]
                             [--if-match]
                             [--operation-id]
                             [--params]

Exemplos

Cria uma nova operação na API com vários parâmetros

az apim api operation create --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --url-template "/session/{param1}/{param2}" --method "GET" --display-name MyOperationName --description MyDescription --template-parameters name=param1 description=descriptionContent type=paramType required="true" --template-parameters name=param2 required="false" type="string"

Parâmetros Exigidos

--api-id

Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. Revisão não corrente tem ; rev=n como um sufixo onde n é o número da revisão.

--display-name

Obrigatório. Nome da operação.

--method

Obrigatório. Um método de operação HTTP válido. Métodos Http típicos como GET, PUT, POST, mas não limitados apenas por eles.

--resource-group -g

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.

--url-template

Modelo de URL relativa identificando o recurso de destino para esta operação. Pode incluir parâmetros.

Parâmetros Opcionais

--description

Descrição da operação. Pode incluir marcas de formatação HTML.

--if-match

ETag da entidade.

--operation-id

Identificador de operação dentro de uma API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.

--params --template-parameters -p

Coleção de parâmetros de modelo de URL.

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az apim api operation delete

Editar

Exclui a operação especificada na API.

az apim api operation delete --api-id
                             --operation-id
                             --resource-group
                             --service-name
                             [--if-match]

Exemplos

Exclui a operação especificada na API.

az apim api operation delete --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --operation-id MyOperationId

Parâmetros Exigidos

--api-id

Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. Revisão não corrente tem ; rev=n como um sufixo onde n é o número da revisão.

--operation-id

Identificador de operação dentro de uma API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.

--resource-group -g

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 Opcionais

--if-match

ETag da entidade.

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az apim api operation list

Editar

Liste uma coleção das operações para a API especificada.

az apim api operation list --api-id
                           --resource-group
                           --service-name

Exemplos

Liste uma coleção das operações para a API especificada.

az apim api operation list --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId

Parâmetros Exigidos

--api-id

Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. Revisão não corrente tem ; rev=n como um sufixo onde n é o número da revisão.

--resource-group -g

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

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az apim api operation show

Editar

Obtém os detalhes da Operação de API especificada por seu identificador.

az apim api operation show --api-id
                           --operation-id
                           --resource-group
                           --service-name

Exemplos

Obtém os detalhes da Operação de API especificada por seu identificador.

az apim api operation show --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --operation-id MyOperationId

Parâmetros Exigidos

--api-id

Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. Revisão não corrente tem ; rev=n como um sufixo onde n é o número da revisão.

--operation-id

Identificador de operação dentro de uma API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.

--resource-group -g

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

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az apim api operation update

Editar

Atualiza os detalhes da operação na API especificada por seu identificador.

az apim api operation update --api-id
                             --operation-id
                             --resource-group
                             --service-name
                             [--add]
                             [--description]
                             [--display-name]
                             [--force-string]
                             [--if-match]
                             [--method]
                             [--remove]
                             [--set]
                             [--url-template]

Exemplos

Atualiza método, displayname, descrição da operação na API especificada por seu identificador.

az apim api operation update --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --operation-id MyOperationId --method "PUT" --display-name NewDisplayName --description NewDescription

Parâmetros Exigidos

--api-id

Identificador de API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API. Revisão não corrente tem ; rev=n como um sufixo onde n é o número da revisão.

--operation-id

Identificador de operação dentro de uma API. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.

--resource-group -g

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 Opcionais

--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valores de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>.

Valor padrão: []
--description

Descrição da operação. Pode incluir marcas de formatação HTML.

--display-name

Obrigatório. Nome da operação.

--force-string

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

Valor padrão: False
--if-match

ETag da entidade.

--method

Obrigatório. Um método de operação HTTP válido. Métodos Http típicos como GET, PUT, POST, mas não limitados apenas por eles.

--remove

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

Valor padrão: []
--set

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

Valor padrão: []
--url-template

Modelo de URL relativa identificando o recurso de destino para esta operação. Pode incluir parâmetros.

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.