az apim api versionset

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

Команды

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

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

 Core GA
az apim api versionset delete

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

 Core GA
az apim api versionset list

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

 Core GA
az apim api versionset show

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

 Core GA
az apim api versionset update

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

 Core GA

az apim api versionset create

Изменить

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

az apim api versionset create --display-name
                              --resource-group
                              --service-name
                              --versioning-scheme
                              [--acquire-policy-token]
                              [--change-reference]
                              [--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

Required. Имя набора версий API.

--resource-group -g

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

--service-name -n

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

--versioning-scheme

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

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

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--description

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

--if-match

ETag сущности.

--version-header-name

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

--version-query-name

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

--version-set-id

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

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

Изменить

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

az apim api versionset delete --resource-group
                              --service-name
                              --version-set-id
                              [--acquire-policy-token]
                              [--change-reference]
                              [--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.

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

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--if-match

ETag сущности.

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

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

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

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

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

Изменить

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

az apim api versionset update --resource-group
                              --service-name
                              --version-set-id
                              [--acquire-policy-token]
                              [--add]
                              [--change-reference]
                              [--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 VersionSet, указанного его идентификатором.

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.

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

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--add

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

Свойство Значение
Группа параметров: Generic Update Arguments
Default value: []
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--description

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

--display-name

Required. Имя набора версий API.

--force-string

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

Свойство Значение
Группа параметров: Generic Update Arguments
Default value: False
--if-match

ETag сущности.

--remove

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

Свойство Значение
Группа параметров: Generic Update Arguments
Default value: []
--set

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

Свойство Значение
Группа параметров: Generic Update Arguments
Default value: []
--version-header-name

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

--version-query-name

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

--versioning-scheme

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

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