az apic api version

  • Ссылка

Примечание.

Эта ссылка является частью расширения apic-extension для Azure CLI (версия 2.57.0 или более поздней). Расширение автоматически установит первый раз, когда вы запускаете команду az apic api version . Подробнее о расширениях.

Команды для управления версиями API в Центре API.

Команды

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

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

 Расширение Общедоступная версия
az apic api version delete

Удалите указанную версию API.

 Расширение Общедоступная версия
az apic api version list

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

 Расширение Общедоступная версия
az apic api version show

Получение сведений о версии API.

 Расширение Общедоступная версия
az apic api version update

Обновите существующую версию API.

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

az apic api version create

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

az apic api version create --api-id
                           --lifecycle-stage {deprecated, design, development, preview, production, retired, testing}
                           --resource-group
                           --service
                           --title
                           --version-id

Примеры

Создание версии API

az apic api version create -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --title "2023-01-01"

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

--api-id

Идентификатор API.

--lifecycle-stage

Текущий этап жизненного цикла API.

допустимые значения: deprecated, design, development, preview, production, retired, testing
--resource-group -g

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

--service --service-name -s

Имя службы Центра API.

--title

Версия API.

--version-id

Идентификатор версии 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 apic api version delete

Удалите указанную версию API.

az apic api version delete [--api-id]
                           [--ids]
                           [--resource-group]
                           [--service]
                           [--subscription]
                           [--version-id]
                           [--yes]

Примеры

Удаление версии API

az apic api version delete -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01

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

--api-id

Идентификатор API.

--ids

Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.

--resource-group -g

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

--service --service-name -s

Имя службы Центра API.

--subscription

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

--version-id

Идентификатор версии API.

--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 apic api version list

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

az apic api version list --api-id
                         --resource-group
                         --service
                         [--filter]
                         [--max-items]
                         [--next-token]

Примеры

Список версий API

az apic api version list -g api-center-test -s contosoeuap --api-id echo-api

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

--api-id

Идентификатор API.

--resource-group -g

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

--service --service-name -s

Имя службы Центра API.

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

--filter

Параметр фильтра OData.

--max-items

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

--next-token

Маркер, чтобы указать, где начать разбиение на страницы. Это значение маркера из ранее усеченного ответа.

Глобальные параметры
--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 apic api version show

Получение сведений о версии API.

az apic api version show [--api-id]
                         [--ids]
                         [--resource-group]
                         [--service]
                         [--subscription]
                         [--version-id]

Примеры

Отображение сведений о версии API

az apic api version show -g api-center-test -s contoso --api-id echo-api --version-id 2023-01-01

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

--api-id

Идентификатор API.

--ids

Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.

--resource-group -g

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

--service --service-name -s

Имя службы Центра API.

--subscription

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

--version-id

Идентификатор версии 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 apic api version update

Обновите существующую версию API.

az apic api version update [--add]
                           [--api-id]
                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                           [--ids]
                           [--lifecycle-stage {deprecated, design, development, preview, production, retired, testing}]
                           [--remove]
                           [--resource-group]
                           [--service]
                           [--set]
                           [--subscription]
                           [--title]
                           [--version-id]

Примеры

Обновление версии API

az apic api version update -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --title "2023-01-01"

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

--add

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

--api-id

Идентификатор API.

--force-string

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

допустимые значения: 0, 1, f, false, n, no, t, true, y, yes
--ids

Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.

--lifecycle-stage

Текущий этап жизненного цикла API.

допустимые значения: deprecated, design, development, preview, production, retired, testing
--remove

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

--resource-group -g

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

--service --service-name -s

Имя службы Центра API.

--set

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

--subscription

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

--title

Версия API.

--version-id

Идентификатор версии 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.