Поделиться через

az apim api operation

  • Ссылка

Управление операциями API управления API Azure.

Команды

Имя Описание Тип Состояние
az apim api operation create

Создает новую операцию в API.

 Ядро ГА
az apim api operation delete

Удаляет указанную операцию в API.

 Ядро ГА
az apim api operation list

Перечислить коллекцию операций для указанного API.

 Ядро ГА
az apim api operation show

Возвращает сведения о операции API, указанной его идентификатором.

 Ядро ГА
az apim api operation update

Обновляет сведения об операции в API, указанной его идентификатором.

 Ядро ГА

az apim api operation create

Изменить

Создает новую операцию в API.

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

Примеры

Создает новую операцию в API с несколькими параметрами

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"

Обязательные параметры

--api-id

Идентификатор API. Должен быть уникальным в текущем экземпляре службы управления API. Имеется не текущая редакция; rev=n как суффикс, где n является номером редакции.

--display-name

Обязательное. Имя операции.

--method

Обязательное. Допустимый метод операции HTTP. Типичные методы HTTP, такие как GET, PUT, POST, но не ограничены только ими.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--service-name -n

Имя экземпляра службы управления API.

--url-template

Относительный шаблон URL-адреса, определяющий целевой ресурс для этой операции. Может включать параметры.

Необязательные параметры

--description

Описание операции. Может включать теги форматирования HTML.

--if-match

ETag сущности.

--operation-id

Идентификатор операции в API. Должен быть уникальным в текущем экземпляре службы управления API.

--params --template-parameters -p

Коллекция параметров шаблона URL-адреса.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az apim api operation delete

Изменить

Удаляет указанную операцию в API.

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

Примеры

Удаляет указанную операцию в API.

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

Обязательные параметры

--api-id

Идентификатор API. Должен быть уникальным в текущем экземпляре службы управления API. Имеется не текущая редакция; rev=n как суффикс, где n является номером редакции.

--operation-id

Идентификатор операции в API. Должен быть уникальным в текущем экземпляре службы управления API.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--service-name -n

Имя экземпляра службы управления API.

Необязательные параметры

--if-match

ETag сущности.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az apim api operation list

Изменить

Перечислить коллекцию операций для указанного API.

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

Примеры

Перечислить коллекцию операций для указанного API.

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

Обязательные параметры

--api-id

Идентификатор API. Должен быть уникальным в текущем экземпляре службы управления API. Имеется не текущая редакция; rev=n как суффикс, где n является номером редакции.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--service-name -n

Имя экземпляра службы управления API.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az apim api operation show

Изменить

Возвращает сведения о операции API, указанной его идентификатором.

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

Примеры

Возвращает сведения о операции API, указанной его идентификатором.

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

Обязательные параметры

--api-id

Идентификатор API. Должен быть уникальным в текущем экземпляре службы управления API. Имеется не текущая редакция; rev=n как суффикс, где n является номером редакции.

--operation-id

Идентификатор операции в API. Должен быть уникальным в текущем экземпляре службы управления API.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--service-name -n

Имя экземпляра службы управления API.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az apim api operation update

Изменить

Обновляет сведения об операции в API, указанной его идентификатором.

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]

Примеры

Метод обновления, отображаемое имя, описание операции в API, указанной его идентификатором.

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

Обязательные параметры

--api-id

Идентификатор API. Должен быть уникальным в текущем экземпляре службы управления API. Имеется не текущая редакция; rev=n как суффикс, где n является номером редакции.

--operation-id

Идентификатор операции в API. Должен быть уникальным в текущем экземпляре службы управления API.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--service-name -n

Имя экземпляра службы управления API.

Необязательные параметры

--add

Добавьте объект в список объектов, указав пары пути и значения ключа. Пример: --add property.listProperty <key=value, string or JSON string>.

Default value: []
--description

Описание операции. Может включать теги форматирования HTML.

--display-name

Обязательное. Имя операции.

--force-string

При использовании "set" или "add" сохраняйте строковые литералы вместо попытки преобразовать в JSON.

Default value: False
--if-match

ETag сущности.

--method

Обязательное. Допустимый метод операции HTTP. Типичные методы HTTP, такие как GET, PUT, POST, но не ограничены только ими.

--remove

Удалите свойство или элемент из списка. Пример: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Default value: []
--set

Обновите объект, указав путь к свойству и значение для задания. Пример: --set property1.property2=<value>.

Default value: []
--url-template

Относительный шаблон URL-адреса, определяющий целевой ресурс для этой операции. Может включать параметры.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.