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

az apim product

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

Команды

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

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

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

--approval-required

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

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

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

--legal-terms

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

--no-wait

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

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

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

--state

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

Свойство Значение
Допустимые значения: notPublished, published
--subscription-required -s

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

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

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

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

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

--delete-subscriptions

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

--if-match

ETag сущности.

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

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

Свойство Значение
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 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

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

Свойство Значение
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 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.

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

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: []
--approval-required

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

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

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

--force-string

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

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

ETag сущности.

--legal-terms

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

--no-wait

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

Свойство Значение
Default value: False
--product-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: []
--state

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

Свойство Значение
Допустимые значения: notPublished, published
--subscription-required -s

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

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

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

Изменить

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

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

Примеры

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

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.

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

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