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

az apic environment

  • Ссылка

Примечание.

Эта ссылка является частью расширения apic-extension для Azure CLI (версия 2.57.0 или более поздней). Расширение будет автоматически устанавливаться при первом запуске команды az apic environment . Подробнее о расширениях.

Команды для управления средами в Центре API.

Команды

Имя Описание Тип Состояние
az apic environment create

Создайте новую среду или обновите существующую среду.

 Расширение Общедоступная версия
az apic environment delete

Удаление среды.

 Расширение Общедоступная версия
az apic environment list

Перечисление коллекции сред.

 Расширение Общедоступная версия
az apic environment show

Получение сведений об среде.

 Расширение Общедоступная версия
az apic environment update

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

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

az apic environment create

Создайте новую среду или обновите существующую среду.

az apic environment create --environment-id
                           --resource-group
                           --service-name
                           --title
                           --type {development, production, staging, testing}
                           [--custom-properties]
                           [--description]
                           [--onboarding]
                           [--server]

Примеры

Создать окружение

az apic environment create -g api-center-test -n contosoeuap --environment-id public --title "Public cloud" --type "development"

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

--environment-id

Идентификатор среды.

--resource-group -g

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

--service-name -n

Имя службы Центра API Azure.

--title

Название среды.

--type

Тип среды.

Допустимые значения: development, production, staging, testing

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

--custom-properties

Пользовательские метаданные, определенные для сущностей каталога API. Поддержка json-file и yaml-file.

--description

Описание среды.

--onboarding

Предоставьте документацию по подключению, связанную с вашей средой, например {developerPortalUri:['https://developer.contoso.com],инструкции:'instructions markdown'} Support shorthand-синтаксис, json-file и yaml-file. Попробуйте "??", чтобы показать больше.

--server

Сведения о сервере среды. Поддержка сокращенного синтаксиса, json-file и yaml-file. Попробуйте "??", чтобы показать больше.

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

Удаление среды.

az apic environment delete [--environment-id]
                           [--ids]
                           [--resource-group]
                           [--service-name]
                           [--subscription]
                           [--yes]

Примеры

Удалить среду

az apic environment delete -g api-center-test -n contosoeuap --environment-id public

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

--environment-id

Идентификатор среды.

--ids

Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.

--resource-group -g

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

--service-name -n

Имя службы Центра API Azure.

--subscription

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

--yes -y

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

Default value: False
Глобальные параметры
--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 apic environment list

Перечисление коллекции сред.

az apic environment list --resource-group
                         --service-name
                         [--filter]
                         [--max-items]
                         [--next-token]

Примеры

Создание списка сред

az apic environment list -g api-center-test -n contosoeuap

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

--resource-group -g

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

--service-name -n

Имя службы Центра API Azure.

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

--filter

Параметр фильтра OData.

--max-items

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

--next-token

Маркер, чтобы указать, где начать разбиение на страницы. Это значение маркера из ранее усеченного ответа.

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

Получение сведений об среде.

az apic environment show [--environment-id]
                         [--ids]
                         [--resource-group]
                         [--service-name]
                         [--subscription]

Примеры

Отображение сведений о среде

az apic environment show -g api-center-test -n contosoeuap --environment-id public

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

--environment-id

Идентификатор среды.

--ids

Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.

--resource-group -g

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

--service-name -n

Имя службы Центра API Azure.

--subscription

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

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

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

az apic environment update [--add]
                           [--custom-properties]
                           [--description]
                           [--environment-id]
                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                           [--ids]
                           [--onboarding]
                           [--remove]
                           [--resource-group]
                           [--server]
                           [--service-name]
                           [--set]
                           [--subscription]
                           [--title]
                           [--type {development, production, staging, testing}]

Примеры

Обновление среды

az apic environment update -g api-center-test -n contosoeuap --environment-id public --title "Public cloud"

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

--add

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

--custom-properties

Пользовательские метаданные, определенные для сущностей каталога API. Поддержка json-file и yaml-file.

--description

Описание.

--environment-id

Идентификатор среды.

--force-string

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

Допустимые значения: 0, 1, f, false, n, no, t, true, y, yes
--ids

Один или несколько идентификаторов ресурсов (через пробелы). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие аргументы Resource Id.

--onboarding

{developerPortalUri:['https://developer.contoso.com],instructions:'instructions markdown'} Support shorthand-синтаксис, json-file и yaml-file. Попробуйте "??", чтобы показать больше.

--remove

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

--resource-group -g

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

--server

Сведения о сервере среды. Поддержка сокращенного синтаксиса, json-file и yaml-file. Попробуйте "??", чтобы показать больше.

--service-name -n

Имя службы Центра API Azure.

--set

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

--subscription

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

--title

Название среды.

--type

Тип среды.

Допустимые значения: development, production, staging, testing
Глобальные параметры
--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.