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

az apim

  • Ссылка

Управление службами Azure Управление API.

Команды

Имя Описание Тип Состояние
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 apply-network-updates

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

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

Создает резервную копию службы Управление API для указанной учетной записи служба хранилища Azure. Это длительная операция и может занять несколько минут.

 Основные сведения Общедоступная версия
az apim check-name

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

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

Создание экземпляра службы управления API Azure

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

Удаляет службу Управление API.

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

Управление обратимо удаленными службами Azure Управление API.

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

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

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

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

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

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

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

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

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

Управление разрешениями API GraphQL в Azure Управление API.

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

Создайте новый сопоставитель в API GraphQL или обновите существующий.

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

Удалите указанный сопоставитель в API GraphQL.

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

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

 Основные сведения Общедоступная версия
az apim graphql resolver policy

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

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

Создание или обновление конфигурации политики для уровня сопоставителя API GraphQL.

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

Удалите конфигурацию политики в сопоставитель API GraphQL.

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

Получите список конфигурации политики на уровне сопоставителя API GraphQL.

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

Получите конфигурацию политики на уровне сопоставителя API GraphQL.

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

Получите сведения о сопоставитель API GraphQL, указанный его идентификатором.

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

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

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

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

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

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

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

Удалите Управление API именованное значение.

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

Вывод списка именованных значений Управление API.

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

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

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

Возвращает секрет именованного значения Управление API.

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

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

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

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

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

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

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

Управление API Управление API продукта Azure.

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

Добавьте API в указанный продукт.

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

Проверяет, что сущность API, указанная идентификатором, связана с сущностью Product.

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

Удаляет указанный API из указанного продукта.

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

Возвращает коллекцию API, связанных с продуктом.

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

Создает продукт.

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

Удаление продукта.

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

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

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

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

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

Обновите существующие сведения о продукте.

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

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

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

Восстанавливает резервную копию службы Управление API, созданной с помощью операции ApiManagementService_Backup текущей службы. Это длительная операция и может занять несколько минут.

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

Отображение сведений о экземпляре службы Управление API.

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

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

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

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

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

az apim apply-network-updates

Изменить

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

az apim apply-network-updates --name
                              --resource-group
                              [--location]
                              [--no-wait]

Примеры

Обновление параметров виртуальной сети экземпляра службы Управление API

az apim apply-network-updates --name MyApim -g MyResourceGroup

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

--name -n

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

--resource-group -g

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

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

--location -l

Location. Значения из az account list-locations. Расположение по умолчанию можно настроить с помощью az configure --defaults location=<location>.

--no-wait

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

значение по умолчанию: 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 backup

Изменить

Создает резервную копию службы Управление API для указанной учетной записи служба хранилища Azure. Это длительная операция и может занять несколько минут.

az apim backup --backup-name
               --container-name
               --name
               --resource-group
               --storage-account-key
               --storage-account-name
               [--no-wait]

Примеры

Создание резервной копии экземпляра службы Управление API

az apim backup --name MyApim -g MyResourceGroup --backup-name myBackup              --storage-account-name mystorageaccount --storage-account-container backups              --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==

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

--backup-name

Имя создаваемого файла резервной копии.

--container-name --storage-account-container

Имя контейнера учетной записи хранения, используемого для размещения резервной копии.

--name -n

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

--resource-group -g

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

--storage-account-key

Ключ доступа учетной записи хранения, используемой для размещения резервной копии.

--storage-account-name

Имя учетной записи хранения, используемой для размещения резервной копии.

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

--no-wait

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

значение по умолчанию: 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 check-name

Изменить

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

az apim check-name --name

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

--name -n

Имя экземпляра службы управления 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 create

Изменить

Создание экземпляра службы управления API Azure

az apim create --name
               --publisher-email
               --publisher-name
               --resource-group
               [--disable-gateway {false, true}]
               [--enable-client-certificate {false, true}]
               [--enable-managed-identity {false, true}]
               [--location]
               [--no-wait]
               [--public-network-access {false, true}]
               [--sku-capacity]
               [--sku-name {Basic, Consumption, Developer, Isolated, Premium, Standard}]
               [--tags]
               [--virtual-network {External, Internal, None}]

Примеры

Создайте службу Управление API уровня разработчика.

az apim create --name MyApim -g MyResourceGroup -l eastus --publisher-email email@mydomain.com --publisher-name Microsoft

Создайте службу Управление API уровня потребления.

az apim create --name MyApim -g MyResourceGroup -l eastus --sku-name Consumption --enable-client-certificate \
    --publisher-email email@mydomain.com --publisher-name Microsoft

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

--name -n

Уникальное имя создаваемого экземпляра службы.

Имя должно быть глобально уникальным, так как оно будет включено в качестве имени узла шлюза, например' https://my-api-servicename.azure-api.net. См. примеры:

--publisher-email

Адрес электронной почты для получения всех системных уведомлений.

--publisher-name

Имя вашей организации для использования на портале разработчика и уведомлениях по электронной почте.

--resource-group -g

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

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

--disable-gateway

Отключите шлюз в главном регионе. Допустимо только для службы управления API, развернутой в нескольких расположениях.

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

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

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

Создайте управляемое удостоверение для службы Управление API для доступа к другим ресурсам Azure. Предназначено только для использования для службы SKU потребления.

допустимые значения: false, true
значение по умолчанию: False
--location -l

Location. Значения из az account list-locations. Расположение по умолчанию можно настроить с помощью az configure --defaults location=<location>.

--no-wait

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

значение по умолчанию: False
--public-network-access

Допускается ли доступ к общедоступной конечной точке для этой службы Управление API. Если задано значение true, частные конечные точки являются эксклюзивным методом доступа.

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

Количество развернутых единиц SKU.

значение по умолчанию: 1
--sku-name

SKU экземпляра управления API.

допустимые значения: Basic, Consumption, Developer, Isolated, Premium, Standard
значение по умолчанию: Developer
--tags

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

--virtual-network -v

Тип виртуальной сети.

допустимые значения: External, Internal, None
значение по умолчанию: None
Глобальные параметры
--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 delete

Изменить

Удаляет службу Управление API.

az apim delete --name
               --resource-group
               [--no-wait]
               [--yes]

Примеры

Удаление службы Управление API.

az apim delete -n MyApim -g MyResourceGroup

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

--name -n

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

--resource-group -g

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

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

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

Изменить

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

az apim list [--resource-group]

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

--resource-group -g

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

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

Изменить

Восстанавливает резервную копию службы Управление API, созданной с помощью операции ApiManagementService_Backup текущей службы. Это длительная операция и может занять несколько минут.

az apim restore --backup-name
                --container-name
                --name
                --resource-group
                --storage-account-key
                --storage-account-name
                [--no-wait]

Примеры

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

az apim restore --name MyApim -g MyResourceGroup --backup-name myBackup              --storage-account-name mystorageaccount --storage-account-container backups              --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==

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

--backup-name

Имя файла резервной копии для восстановления.

--container-name --storage-account-container

Имя контейнера учетной записи хранения, используемого для получения резервной копии.

--name -n

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

--resource-group -g

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

--storage-account-key

Ключ доступа учетной записи хранения, используемой для получения резервной копии.

--storage-account-name

Имя учетной записи хранения, используемой для получения резервной копии.

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

--no-wait

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

значение по умолчанию: 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 show

Изменить

Отображение сведений о экземпляре службы Управление API.

az apim show --name
             --resource-group

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

--name -n

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

--resource-group -g

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

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

Изменить

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

az apim update --name
               --resource-group
               [--add]
               [--disable-gateway {false, true}]
               [--enable-client-certificate {false, true}]
               [--enable-managed-identity {false, true}]
               [--force-string]
               [--no-wait]
               [--public-network-access {false, true}]
               [--publisher-email]
               [--publisher-name]
               [--remove]
               [--set]
               [--sku-capacity]
               [--sku-name {Basic, Consumption, Developer, Isolated, Premium, Standard}]
               [--tags]
               [--virtual-network {External, Internal, None}]

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

--name -n

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

--resource-group -g

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

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

--add

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

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

Отключите шлюз в главном регионе. Допустимо только для службы управления API, развернутой в нескольких расположениях.

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

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

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

Создайте управляемое удостоверение для службы Управление API для доступа к другим ресурсам Azure. Предназначено только для использования для службы SKU потребления.

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

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

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

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

значение по умолчанию: False
--public-network-access

Допускается ли доступ к общедоступной конечной точке для этой службы Управление API. Если задано значение true, частные конечные точки являются эксклюзивным методом доступа.

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

Адрес электронной почты для получения всех системных уведомлений.

--publisher-name

Имя вашей организации для использования на портале разработчика и уведомлениях по электронной почте.

--remove

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

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

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

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

Количество развернутых единиц SKU.

--sku-name

SKU экземпляра управления API.

допустимые значения: Basic, Consumption, Developer, Isolated, Premium, Standard
--tags

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

--virtual-network -v

Тип виртуальной сети.

допустимые значения: External, Internal, None
Глобальные параметры
--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 wait

Изменить

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

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

Примеры

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

az apim wait --created --name MyApim --resource-group MyResourceGroup

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

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