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

az apim

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

Команды

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

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

 Core GA
az apim api create

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

 Core GA
az apim api delete

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

 Core GA
az apim api export

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

 Core GA
az apim api import

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

 Core GA
az apim api list

Перечисление API управления API.

 Core GA
az apim api operation

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

 Core GA
az apim api operation create

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

 Core GA
az apim api operation delete

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

 Core GA
az apim api operation list

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

 Core GA
az apim api operation show

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

 Core GA
az apim api operation update

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

 Core GA
az apim api release

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

 Core GA
az apim api release create

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

 Core GA
az apim api release delete

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

 Core GA
az apim api release list

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

 Core GA
az apim api release show

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

 Core GA
az apim api release update

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

 Core GA
az apim api revision

Управление редакцией API управления API Azure.

 Core GA
az apim api revision create

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

 Core GA
az apim api revision list

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

 Core GA
az apim api schema

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

 Core GA
az apim api schema create

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

 Core GA
az apim api schema delete

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

 Core GA
az apim api schema get-etag

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

 Core GA
az apim api schema list

Вывод списка схем API управления API.

 Core GA
az apim api schema show

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

 Core GA
az apim api schema wait

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

 Core GA
az apim api show

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

 Core GA
az apim api update

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

 Core GA
az apim api versionset

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

 Core GA
az apim api versionset create

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

 Core GA
az apim api versionset delete

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

 Core GA
az apim api versionset list

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

 Core GA
az apim api versionset show

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

 Core GA
az apim api versionset update

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

 Core GA
az apim api wait

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

 Core GA
az apim apply-network-updates

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

 Core GA
az apim backup

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

 Core GA
az apim check-name

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

 Core GA
az apim create

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

 Core GA
az apim delete

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

 Core GA
az apim deletedservice

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

 Core GA
az apim deletedservice list

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

 Core GA
az apim deletedservice purge

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

 Core GA
az apim deletedservice show

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

 Core GA
az apim graphql

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

 Core GA
az apim graphql resolver

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

 Core GA
az apim graphql resolver create

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

 Core GA
az apim graphql resolver delete

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

 Core GA
az apim graphql resolver list

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

 Core GA
az apim graphql resolver policy

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

 Core GA
az apim graphql resolver policy create

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

 Core GA
az apim graphql resolver policy delete

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

 Core GA
az apim graphql resolver policy list

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

 Core GA
az apim graphql resolver policy show

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

 Core GA
az apim graphql resolver show

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

 Core GA
az apim list

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

 Core GA
az apim nv

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

 Core GA
az apim nv create

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

 Core GA
az apim nv delete

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

 Core GA
az apim nv list

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

 Core GA
az apim nv show

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

 Core GA
az apim nv show-secret

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

 Core GA
az apim nv update

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

 Core GA
az apim nv wait

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

 Core GA
az apim product

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

 Core GA
az apim product api

Управление API-интерфейсами продукта управления API Azure.

 Core GA
az apim product api add

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

 Core GA
az apim product api check

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

 Core GA
az apim product api delete

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

 Core GA
az apim product api list

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

 Core GA
az apim product create

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

 Core GA
az apim product delete

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

 Core GA
az apim product list

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

 Core GA
az apim product show

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

 Core GA
az apim product update

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

 Core GA
az apim product wait

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

 Core GA
az apim restore

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

 Core GA
az apim show

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

 Core GA
az apim update

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

 Core GA
az apim wait

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

 Core GA

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--location -l

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

--no-wait

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

Свойство Значение
Default value: False
Глобальные параметры
--debug

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

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

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az apim backup

Изменить

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

az apim backup --backup-name
               --container-name --storage-account-container
               --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

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

Свойство Значение
Parameter group: Storage Arguments
--storage-account-name

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

Свойство Значение
Parameter group: Storage Arguments

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

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

Свойство Значение
Default value: False
Глобальные параметры
--debug

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

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

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az apim check-name

Изменить

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

az apim check-name --name

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

--name -n

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

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

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

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

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az apim create

Изменить

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

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 protected] --publisher-name Microsoft

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

az apim create --name MyApim -g MyResourceGroup -l eastus --sku-name Consumption --enable-client-certificate \
    --publisher-email [email protected] --publisher-name Microsoft

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

--name -n

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

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

--publisher-email

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

--publisher-name

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

--resource-group -g

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--disable-gateway

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

Свойство Значение
Допустимые значения: false, true
--enable-client-certificate

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

Свойство Значение
Допустимые значения: false, true
--enable-managed-identity

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

Свойство Значение
Default value: False
Допустимые значения: false, true
--location -l

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

--no-wait

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

Свойство Значение
Default value: False
--public-network-access

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

Свойство Значение
Допустимые значения: false, true
--sku-capacity

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

Свойство Значение
Default value: 1
--sku-name

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

Свойство Значение
Default value: Developer
Допустимые значения: Basic, Consumption, Developer, Isolated, Premium, Standard
--tags

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

--virtual-network -v

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

Свойство Значение
Default value: None
Допустимые значения: External, Internal, None
Глобальные параметры
--debug

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

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

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

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

Свойство Значение
Default value: False
--yes -y

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

Свойство Значение
Default value: False
Глобальные параметры
--debug

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

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

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az apim list

Изменить

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

az apim list [--resource-group]

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

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

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

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

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

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az apim restore

Изменить

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

az apim restore --backup-name
                --container-name --storage-account-container
                --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

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

Свойство Значение
Parameter group: Storage Arguments
--storage-account-name

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

Свойство Значение
Parameter group: Storage Arguments

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

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

Свойство Значение
Default value: False
Глобальные параметры
--debug

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

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

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az apim show

Изменить

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

az apim show --name
             --resource-group

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

--name -n

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

--resource-group -g

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

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

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

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

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

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

Свойство Значение
Parameter group: Generic Update Arguments
Default value: []
--disable-gateway

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

Свойство Значение
Допустимые значения: false, true
--enable-client-certificate

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

Свойство Значение
Допустимые значения: false, true
--enable-managed-identity

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

Свойство Значение
Допустимые значения: false, true
--force-string

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

Свойство Значение
Parameter group: Generic Update Arguments
Default value: False
--no-wait

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

Свойство Значение
Default value: False
--public-network-access

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

Свойство Значение
Допустимые значения: false, true
--publisher-email

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

--publisher-name

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

--remove

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

Свойство Значение
Parameter group: Generic Update Arguments
Default value: []
--set

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

Свойство Значение
Parameter group: Generic Update Arguments
Default 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

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

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

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False

az apim wait

Изменить

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

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

Примеры

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

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

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

--name -n

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

--resource-group -g

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

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

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: False
--custom

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

Свойство Значение
Parameter group: Wait Condition Arguments
--deleted

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

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: False
--exists

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

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: False
--interval

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

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: 30
--timeout

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

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

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

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: False
Глобальные параметры
--debug

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

Свойство Значение
Default value: False
--help -h

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

--only-show-errors

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

Свойство Значение
Default value: False
--output -o

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

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

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

--subscription

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

--verbose

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

Свойство Значение
Default value: False