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

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

Изменить

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

az apim product api add --api-id
                        --product-id
                        --resource-group
                        --service-name

Примеры

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

az apim product api add --resource-group MyResourceGroup --service-name MyServiceName  --product-id MyProductID --api-id MyAPIID

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

--api-id

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

--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
Default value: json
--query

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

--subscription

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

--verbose

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

az apim product api check

Изменить

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

az apim product api check --api-id
                          --product-id
                          --resource-group
                          --service-name

Примеры

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

az apim product api check --resource-group MyResourceGroup  --service-name MyServiceName  --product-id MyProductID --api-id MyAPIID

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

--api-id

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

--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
Default value: json
--query

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

--subscription

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

--verbose

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

az apim product api delete

Изменить

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

az apim product api delete --api-id
                           --product-id
                           --resource-group
                           --service-name

Примеры

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

az apim product api delete --resource-group MyResourceGroup --service-name MyServiceName  --product-id MyProductID --api-id MyAPIID

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

--api-id

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

--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
Default value: json
--query

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

--subscription

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

--verbose

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

az apim product api list

Изменить

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

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

Примеры

Список всех API, связанных с продуктом.

az apim product api list --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
Default value: json
--query

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

--subscription

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

--verbose

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