Partilhar via

az apim api operation

Gerencie as operações da API de Gerenciamento de API do Azure.

Comandos

Name Description Tipo Status
az apim api operation create

Cria uma nova operação na API.

 Core disponibilidade geral
az apim api operation delete

Exclui a operação especificada na API.

 Core disponibilidade geral
az apim api operation list

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

 Core disponibilidade geral
az apim api operation show

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

 Core disponibilidade geral
az apim api operation update

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

 Core disponibilidade geral

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 --template-parameters]

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 Obrigatórios

--api-id

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

Propriedade Valor
Grupo de parâmetros: API Arguments
--display-name

Required. Nome da operação.

--method

Required. 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 relativo que identifica o recurso de destino para esta operação. Pode incluir parâmetros.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--description

Descrição da operação. Pode incluir tags 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 de serviço de Gerenciamento de API atual.

--params --template-parameters -p

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

Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: False

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 Obrigatórios

--api-id

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

Propriedade Valor
Grupo de parâmetros: API Arguments
--operation-id

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

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--if-match

ETag da Entidade.

Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: False

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 Obrigatórios

--api-id

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

Propriedade Valor
Grupo de parâmetros: API Arguments
--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 de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: False

az apim api operation show

Editar

Obtém os detalhes da operação da 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 da API especificada por seu identificador.

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

Parâmetros Obrigatórios

--api-id

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

Propriedade Valor
Grupo de parâmetros: API Arguments
--operation-id

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

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

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: False

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

Método de atualizações, 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 Obrigatórios

--api-id

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

Propriedade Valor
Grupo de parâmetros: API Arguments
--operation-id

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

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

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

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Default value: []
--description

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

--display-name

Required. Nome da operação.

--force-string

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

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Default value: False
--if-match

ETag da Entidade.

--method

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

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Default value: []
--set

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

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Default value: []
--url-template

Modelo de URL relativo que identifica o recurso de destino para esta operação. Pode incluir parâmetros.

Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: False