az apim api

  • Ссылка

Управление API Управление API Azure.

Команды

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

Создайте API Управление API.

 Основные сведения Общедоступная версия
az apim api delete

Удаление API Управление API.

 Основные сведения Общедоступная версия
az apim api export

Экспорт API Управление API.

 Основные сведения Общедоступная версия
az apim api import

Импорт Управление API API.

 Основные сведения Общедоступная версия
az apim api list

Перечисление api Управление API.

 Основные сведения Общедоступная версия
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 release

Управление выпуском API Управление API Azure.

 Основные сведения Общедоступная версия
az apim api release create

Создает новый выпуск для API.

 Основные сведения Общедоступная версия
az apim api release delete

Удаляет указанный выпуск в API.

 Основные сведения Общедоступная версия
az apim api release list

Выводит список всех выпусков API.

 Основные сведения Общедоступная версия
az apim api release show

Возвращает сведения о выпуске API.

 Основные сведения Общедоступная версия
az apim api release update

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

 Основные сведения Общедоступная версия
az apim api revision

Управление версией API Управление API Azure.

 Основные сведения Общедоступная версия
az apim api revision create

Создание редакции API.

 Основные сведения Общедоступная версия
az apim api revision list

Выводит список всех редакций API.

 Основные сведения Общедоступная версия
az apim api schema

Управление схемой API Управление API Azure.

 Основные сведения Общедоступная версия
az apim api schema create

Создайте схему API Управление API.

 Основные сведения Общедоступная версия
az apim api schema delete

Удалите схему API Управление API.

 Основные сведения Общедоступная версия
az apim api schema get-etag

Получение etag схемы API Управление API.

 Основные сведения Общедоступная версия
az apim api schema list

Перечисление схем API Управление API.

 Основные сведения Общедоступная версия
az apim api schema show

Отображение сведений о схеме API Управление API.

 Основные сведения Общедоступная версия
az apim api schema wait

Поместите интерфейс командной строки в состояние ожидания, пока не будет выполнено условие схемы API api.

 Основные сведения Общедоступная версия
az apim api show

Отображение сведений о API Управление API.

 Основные сведения Общедоступная версия
az apim api update

Обновите API Управление API.

 Основные сведения Общедоступная версия
az apim api versionset

Управление набором версий API Управление API Azure.

 Основные сведения Общедоступная версия
az apim api versionset create

Создает набор версий API.

 Основные сведения Общедоступная версия
az apim api versionset delete

Удаляет конкретный набор версий API.

 Основные сведения Общедоступная версия
az apim api versionset list

Возвращает коллекцию наборов версий API в указанном экземпляре службы.

 Основные сведения Общедоступная версия
az apim api versionset show

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

 Основные сведения Общедоступная версия
az apim api versionset update

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

 Основные сведения Общедоступная версия
az apim api wait

Поместите интерфейс командной строки в состояние ожидания, пока не будет выполнено условие API.

 Основные сведения Общедоступная версия

az apim api create

Изменить

Создайте API Управление API.

az apim api create --api-id
                   --display-name
                   --path
                   --resource-group
                   --service-name
                   [--api-type {graphql, http, soap, websocket}]
                   [--authorization-scope]
                   [--authorization-server-id]
                   [--bearer-token-sending-methods]
                   [--description]
                   [--no-wait]
                   [--open-id-provider-id]
                   [--protocols {http, https, ws, wss}]
                   [--service-url]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-key-required]
                   [--subscription-required {false, true}]

Примеры

Создайте базовый API.

az apim api create --service-name MyApim -g MyResourceGroup --api-id MyApi --path '/myapi' --display-name 'My API'

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

--api-id

Уникальное имя создаваемого API.

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

--display-name

Отображаемое имя создаваемого API.

--path

Путь к API.

--resource-group -g

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

--service-name -n

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

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

--api-type

Тип API.

допустимые значения: graphql, http, soap, websocket
--authorization-scope

Указывает операции OAuth область.

--authorization-server-id

Указывает идентификатор сервера авторизации OAuth.

--bearer-token-sending-methods

Задает методы отправки для маркера носителя.

--description

Описание API. Может содержать теги форматирования HTML.

--no-wait

Не ожидать завершения длительной операции.

значение по умолчанию: False
--open-id-provider-id

Указывает openid в параметре проверки подлинности.

--protocols

Описывает, на каких протоколах могут вызываться операции в данном API.

допустимые значения: http, https, ws, wss
--service-url

Абсолютный URL-адрес внутренней службы, реализующей этот API. Не может превышать 2000 символов.

--subscription-key-header-name

Указывает имя заголовка ключа подписки.

--subscription-key-query-param-name

Указывает имя параметра строки запроса ключа подписки.

--subscription-key-required

Указывает, требуется ли ключ подписки во время вызова этого API, true — API включается только в закрытые продукты, false — API включается в открытые продукты только, null — существует сочетание продуктов.

--subscription-required

Если значение true, API требует ключа подписки для запросов.

допустимые значения: false, true
значение по умолчанию: False
Глобальные параметры
--debug

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

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

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

--subscription

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

--verbose

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

az apim api delete

Изменить

Удаление API Управление API.

az apim api delete --api-id
                   --resource-group
                   --service-name
                   [--delete-revisions]
                   [--if-match]
                   [--no-wait]
                   [--yes]

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

--api-id

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

--resource-group -g

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

--service-name -n

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

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

--delete-revisions

Удалите все редакции API.

--if-match

ETag сущности.

--no-wait

Не ожидать завершения длительной операции.

значение по умолчанию: False
--yes -y

Не запрашивать подтверждение.

значение по умолчанию: False
Глобальные параметры
--debug

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

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

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

--subscription

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

--verbose

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

az apim api export

Изменить

Экспорт API Управление API.

az apim api export --api-id
                   --ef {OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl}
                   --resource-group
                   --service-name
                   [--file-path]

Примеры

Экспортируйте УПРАВЛЕНИЕ API API в файл или возвращает ответ, содержащий ссылку на экспорт.

az apim api export -g MyResourceGroup --service-name MyApim --api-id MyApi --export-format OpenApiJson --file-path path

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

--api-id

Идентификатор API. Должен быть уникальным в текущем экземпляре службы Управление API. Имеется не текущая редакция; rev=n как суффикс, где n является номером редакции. Шаблон regex: ^[^*#&+:<>?] +$.

--ef --export-format

Укажите формат API экспорта.

допустимые значения: OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl
--resource-group -g

Имя группы ресурсов. Имя не учитывает регистр.

--service-name -n

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

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

--file-path -f

Путь к файлу, указанный для экспорта API.

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

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

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

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

--subscription

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

--verbose

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

az apim api import

Изменить

Импорт Управление API API.

az apim api import --path
                   --resource-group
                   --service-name
                   --specification-format {GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl}
                   [--api-id]
                   [--api-revision]
                   [--api-type {graphql, http, soap, websocket}]
                   [--api-version]
                   [--api-version-set-id]
                   [--description]
                   [--display-name]
                   [--no-wait]
                   [--protocols {http, https, ws, wss}]
                   [--service-url]
                   [--soap-api-type]
                   [--specification-path]
                   [--specification-url]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-required {false, true}]
                   [--wsdl-endpoint-name]
                   [--wsdl-service-name]

Примеры

Импорт API Управление API из файла или URL-адреса

az apim api import -g MyResourceGroup --service-name MyApim --path MyApi --specification-url https://MySpecificationURL --specification-format OpenApiJson

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

--path

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

--resource-group -g

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

--service-name -n

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

--specification-format

Укажите формат импортированного API.

допустимые значения: GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl

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

--api-id

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

--api-revision

Описывает редакцию API. Если значение не указано, создается версия 1 по умолчанию.

--api-type

Тип API.

допустимые значения: graphql, http, soap, websocket
--api-version

Описывает версию API. Если вы добавляете версию в НЕреверсивный API, исходная версия будет автоматически создана и будет отвечать на URL-адрес по умолчанию.

--api-version-set-id

Описывает набор версий, используемый с API.

--description

Описание API. Может содержать теги форматирования HTML.

--display-name

Отображаемое имя этого API.

--no-wait

Не ожидать завершения длительной операции.

значение по умолчанию: False
--protocols

Описывает, какие протоколы (один или несколько) могут вызываться в этом API.

допустимые значения: http, https, ws, wss
--service-url

Абсолютный URL-адрес внутренней службы, реализующей этот API. Не может превышать 2000 символов.

--soap-api-type

Тип API, если формат файла — WSDL.

--specification-path

Путь к файлу, указанный для импорта API.

--specification-url

URL-адрес, указанный для импорта API.

--subscription-key-header-name

Указывает имя заголовка ключа подписки.

--subscription-key-query-param-name

Указывает имя параметра строки запроса ключа подписки.

--subscription-required

Если значение true, API требует ключа подписки для запросов.

допустимые значения: false, true
--wsdl-endpoint-name

Локальное имя конечной точки WSDL (порт), импортируемое.

--wsdl-service-name

Имя локальной службы WSDL, импортируемой.

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

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

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

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

--subscription

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

--verbose

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

az apim api list

Изменить

Перечисление api Управление API.

az apim api list --resource-group
                 --service-name
                 [--filter-display-name]
                 [--skip]
                 [--top]

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

--resource-group -g

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

--service-name -n

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

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

--filter-display-name

Фильтрация API по displayName.

--skip

Количество пропускаемых записей.

--top

Количество возвращаемых записей.

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

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

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

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

--subscription

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

--verbose

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

az apim api show

Изменить

Отображение сведений о API Управление API.

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

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

--api-id

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

--resource-group -g

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

--service-name

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

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

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

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

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

--subscription

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

--verbose

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

az apim api update

Изменить

Обновите API Управление API.

az apim api update --api-id
                   --resource-group
                   --service-name
                   [--add]
                   [--api-type {graphql, http, soap, websocket}]
                   [--description]
                   [--display-name]
                   [--force-string]
                   [--if-match]
                   [--no-wait]
                   [--path]
                   [--protocols {http, https, ws, wss}]
                   [--remove]
                   [--service-url]
                   [--set]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-required {false, true}]
                   [--tags]

Примеры

Создайте базовый API.

az apim api update --service-name MyApim -g MyResourceGroup --api-id MyApi --description foo

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

--api-id

Уникальное имя создаваемого API.

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

--resource-group -g

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

--service-name -n

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

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

--add

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

значение по умолчанию: []
--api-type

Тип API.

допустимые значения: graphql, http, soap, websocket
--description

Описание API. Может содержать теги форматирования HTML.

--display-name

Имя API. Должно составлять от 1 до 300 символов.

--force-string

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

значение по умолчанию: False
--if-match

ETag сущности. Не требуется при создании сущности, но требуется при обновлении сущности. Значение по умолчанию — None.

--no-wait

Не ожидать завершения длительной операции.

значение по умолчанию: False
--path

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

--protocols

Описывает, на каких протоколах могут вызываться операции в данном API.

допустимые значения: http, https, ws, wss
--remove

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

значение по умолчанию: []
--service-url

Абсолютный URL-адрес внутренней службы, реализующей этот API. Не может превышать 2000 символов.

--set

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

значение по умолчанию: []
--subscription-key-header-name

Указывает имя заголовка ключа подписки.

--subscription-key-query-param-name

Указывает имя параметра строки запроса ключа подписки.

--subscription-required

Если значение true, API требует ключа подписки для запросов.

допустимые значения: false, true
--tags

Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.

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

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

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

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

--subscription

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

--verbose

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

az apim api wait

Изменить

Поместите интерфейс командной строки в состояние ожидания, пока не будет выполнено условие API.

az apim api wait --api-id
                 --name
                 --resource-group
                 [--created]
                 [--custom]
                 [--deleted]
                 [--exists]
                 [--interval]
                 [--timeout]
                 [--updated]

Примеры

Поместите интерфейс командной строки в состояние ожидания, пока не будет выполнено условие API. (автоматическое создание)

az apim api wait --created --api-id MyApi --name MyApim --resource-group MyResourceGroup

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

--api-id

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

--name -n

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

--resource-group -g

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

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

--created

Подождите, пока не будет создано с помощью provisioningState по адресу "Успешно".

значение по умолчанию: False
--custom

Подождите, пока условие не будет удовлетворено пользовательским запросом JMESPath. Например, provisioningState!='InProgress', instanceView.statuses[?code='PowerState/running'].

--deleted

Дождитесь удаления.

значение по умолчанию: False
--exists

Подождите, пока ресурс не существует.

значение по умолчанию: False
--interval

Интервал опроса в секундах.

значение по умолчанию: 30
--timeout

Максимальное ожидание в секундах.

значение по умолчанию: 3600
--updated

Подождите, пока не будет обновлено с помощью provisioningState по адресу "Успешно".

значение по умолчанию: False
Глобальные параметры
--debug

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

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

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

--subscription

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

--verbose

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