az apim api versionset

  • Ссылка

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

Команды

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

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

 Основные сведения Общедоступная версия
az apim api versionset delete

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

 Основные сведения Общедоступная версия
az apim api versionset list

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

 Основные сведения Общедоступная версия
az apim api versionset show

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

 Основные сведения Общедоступная версия
az apim api versionset update

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

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

az apim api versionset create

Изменить

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

az apim api versionset create --display-name
                              --resource-group
                              --service-name
                              --versioning-scheme
                              [--description]
                              [--if-match]
                              [--version-header-name]
                              [--version-query-name]
                              [--version-set-id]

Примеры

Создает набор версий API с схемой версии в качестве заголовка.

az apim api versionset create --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --display-name MyDisplayName --versioning-scheme "Header" --description MyDescription --version-header-name MyHeaderName

Создает набор версий API с схемой версии в качестве запроса.

az apim api versionset create --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --display-name MyDisplayName --versioning-scheme "Query" --description MyDescription --version-query-name MyQueryName

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

--display-name

Обязательно. Имя набора версий API.

--resource-group -g

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

--service-name -n

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

--versioning-scheme

Обязательно. Значение, определяющее расположение identifer версии API в HTTP-запросе. Возможные значения: "Сегмент", "Запрос", "Заголовок".

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

--description

Описание набора версий API.

--if-match

ETag сущности.

--version-header-name

Имя параметра заголовка HTTP, указывающего версию API, если задан headerпараметр versioningScheme.

--version-query-name

Имя параметра запроса, указывающего версию API, если задан queryпараметр versioningScheme.

--version-set-id

Идентификатор ресурса для связанного ApiVersionSet.

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

Изменить

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

az apim api versionset delete --resource-group
                              --service-name
                              --version-set-id
                              [--if-match]

Примеры

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

az apim api versionset delete --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId

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

--resource-group -g

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

--service-name -n

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

--version-set-id

Идентификатор ресурса для связанного ApiVersionSet.

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

--if-match

ETag сущности.

Глобальные параметры
--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 api versionset list

Изменить

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

az apim api versionset list --resource-group
                            --service-name

Примеры

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

az apim api versionset 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 api versionset show

Изменить

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

az apim api versionset show --resource-group
                            --service-name
                            --version-set-id

Примеры

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

az apim api versionset show --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId

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

--resource-group -g

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

--service-name -n

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

--version-set-id

Идентификатор ресурса для связанного ApiVersionSet.

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

Изменить

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

az apim api versionset update --resource-group
                              --service-name
                              --version-set-id
                              [--add]
                              [--description]
                              [--display-name]
                              [--force-string]
                              [--if-match]
                              [--remove]
                              [--set]
                              [--version-header-name]
                              [--version-query-name]
                              [--versioning-scheme]

Примеры

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

az apim api versionset update --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --display-name MyNewDisplayName --description MyNewDescription

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

az apim api versionset update --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --versioning-scheme "Query" --version-query-name MyNewQueryName

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

--resource-group -g

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

--service-name -n

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

--version-set-id

Идентификатор ресурса для связанного ApiVersionSet.

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

--add

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

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

Описание набора версий API.

--display-name

Обязательно. Имя набора версий API.

--force-string

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

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

ETag сущности.

--remove

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

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

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

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

Имя параметра заголовка HTTP, указывающего версию API, если задан headerпараметр versioningScheme.

--version-query-name

Имя параметра запроса, указывающего версию API, если задан queryпараметр versioningScheme.

--versioning-scheme

Обязательно. Значение, определяющее расположение identifer версии API в HTTP-запросе. Возможные значения: "Сегмент", "Запрос", "Заголовок".

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