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


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 product create

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

az apim product create --product-name
                       --resource-group
                       --service-name
                       [--approval-required {false, true}]
                       [--description]
                       [--legal-terms]
                       [--no-wait]
                       [--product-id]
                       [--state {notPublished, published}]
                       [--subscription-required {false, true}]
                       [--subscriptions-limit]

Примеры

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

az apim product create --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --product-name MyProductName --description MyDescription --legal-terms MyTerms --subscription-required true --approval-required true --subscriptions-limit 8 --state "published"

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

--product-name

Название продукта.

--resource-group -g

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

--service-name -n

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

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

--approval-required

Требуется ли утверждение подписки. Если значение false, новые подписки будут утверждены автоматически, что разработчики смогут вызывать API продукта сразу после подписки. Если задано значение true, администраторы должны вручную утвердить подписку, прежде чем разработчик сможет использовать любой из API продукта. Может присутствовать только в том случае, если свойство subscriptionRequired присутствует и имеет значение false.

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

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

--legal-terms

Условия использования продукта. Они будут представлены разработчикам во время оформления подписки на продукт. Им понадобится принять эти условия, чтобы завершить процедуру оформления.

--no-wait

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

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

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

--state

Независимо от того, публикуется ли продукт. Опубликованные продукты доступны пользователям портала разработчика. Не опубликованные продукты видны только администраторам. Состояние продукта по умолчанию не опубликовано. Возможные значения включают: NotPublished, "published".

допустимые значения: notPublished, published
--subscription-required -s

Требуется ли подписка на продукт для доступа к API, включенным в этот продукт.

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

Может ли количество подписок, которые пользователь может одновременно использовать для этого продукта. Установите значение NULL или опустить, чтобы разрешить неограниченное количество подписок пользователей. Может присутствовать только в том случае, если свойство subscriptionRequired присутствует и имеет значение 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 product delete

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

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

Примеры

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

az apim product delete --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --delete-subscriptions true

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

--product-id

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

--resource-group -g

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

--service-name -n

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

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

--delete-subscriptions

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

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

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

az apim product list --resource-group
                     --service-name

Примеры

Список всех продуктов для этого экземпляра APIM.

az apim product list --resource-group MyResourceGroup --service-name MyServiceName

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

--resource-group -g

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

--service-name -n

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

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

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

--help -h

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

--only-show-errors

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

--output -o

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

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

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

--subscription

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

--verbose

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

az apim product show

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

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

Примеры

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

az apim product show --resource-group MyResourceGroup --service-name MyServiceName  --product-id MyProductID

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

--product-id

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

--resource-group -g

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

--service-name -n

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

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

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

--help -h

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

--only-show-errors

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

--output -o

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

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

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

--subscription

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

--verbose

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

az apim product update

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

az apim product update --product-id
                       --resource-group
                       --service-name
                       [--add]
                       [--approval-required {false, true}]
                       [--description]
                       [--force-string]
                       [--if-match]
                       [--legal-terms]
                       [--no-wait]
                       [--product-name]
                       [--remove]
                       [--set]
                       [--state {notPublished, published}]
                       [--subscription-required {false, true}]
                       [--subscriptions-limit]

Примеры

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

az apim product update --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --product-name MyNewProductName --description MyNewDescription --legal-terms MyNewTerms --subscription-required false --state "notPublished"

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

--product-id

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

--resource-group -g

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

--service-name -n

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

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

--add

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

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

Требуется ли утверждение подписки. Если значение false, новые подписки будут утверждены автоматически, что разработчики смогут вызывать API продукта сразу после подписки. Если задано значение true, администраторы должны вручную утвердить подписку, прежде чем разработчик сможет использовать любой из API продукта. Может присутствовать только в том случае, если свойство subscriptionRequired присутствует и имеет значение false.

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

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

--force-string

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

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

ETag сущности.

--legal-terms

Условия использования продукта. Они будут представлены разработчикам во время оформления подписки на продукт. Им понадобится принять эти условия, чтобы завершить процедуру оформления.

--no-wait

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

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

Название продукта.

--remove

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

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

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

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

Независимо от того, публикуется ли продукт. Опубликованные продукты доступны пользователям портала разработчика. Не опубликованные продукты видны только администраторам. Состояние продукта по умолчанию не опубликовано. Возможные значения включают: NotPublished, "published".

допустимые значения: notPublished, published
--subscription-required -s

Требуется ли подписка на продукт для доступа к API, включенным в этот продукт.

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

Может ли количество подписок, которые пользователь может одновременно использовать для этого продукта. Установите значение NULL или опустить, чтобы разрешить неограниченное количество подписок пользователей. Может присутствовать только в том случае, если свойство subscriptionRequired присутствует и имеет значение 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 product wait

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

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

Примеры

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

az apim product wait --created --resource-group MyResourceGroup --service-name MyServiceName --product-id MyProductID

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

--product-id

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

--resource-group -g

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

--service-name -n

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

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

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