az apim backend

Управление серверными Azure API Management.

Команды

Имя	Описание	Тип	Состояние
az apim backend create	Создание или обновление серверной части управления API.	Core	GA
az apim backend delete	Удаление серверной части управления API.	Core	GA
az apim backend list	Вывод списка серверных элементов управления API.	Core	GA
az apim backend show	Отображение сведений о серверной части управления API.	Core	GA
az apim backend update	Обновите серверную часть управления API.	Core	GA

az apim backend create

Изменить

Создание или обновление серверной части управления API.

az apim backend create --backend-id
                       --protocol {http, soap}
                       --resource-group
                       --service-name
                       --url
                       [--acquire-policy-token]
                       [--change-reference]
                       [--description]
                       [--if-match]

Примеры

Создайте серверную часть.

az apim backend create --service-name MyApim -g MyResourceGroup --backend-id MyBackendId --url https://mybackend.com --protocol http

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

--backend-id

Уникальное имя для создаваемой или обновленной серверной части.

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

Свойство	Значение
Группа параметров:	Backend Arguments

--protocol

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

Свойство	Значение
Допустимые значения:	http, soap

--resource-group -g

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

--service-name -n

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

--url

URL-адрес серверной службы.

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

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

--acquire-policy-token

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

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

--change-reference

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

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

--description

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

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

Изменить

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

az apim backend delete --backend-id
                       --resource-group
                       --service-name
                       [--acquire-policy-token]
                       [--change-reference]
                       [--if-match]
                       [--yes]

Примеры

Удалите серверную часть в экземпляре APIM.

az apim backend delete --resource-group MyResourceGroup --service-name MyServiceName --backend-id MyBackendId

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

--backend-id

Идентификатор серверной части.

Свойство	Значение
Группа параметров:	Backend Arguments

--resource-group -g

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

--service-name -n

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

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

--acquire-policy-token

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

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

--change-reference

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

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

--if-match

ETag объекта.

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

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

az apim backend list

Изменить

Вывод списка серверных элементов управления API.

az apim backend list --resource-group
                     --service-name

Примеры

Перечислить все серверные серверы в экземпляре APIM.

az apim backend 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

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

az apim backend show

Изменить

Отображение сведений о серверной части управления API.

az apim backend show --backend-id
                     --resource-group
                     --service-name

Примеры

Отображение сведений о серверной части в экземпляре APIM.

az apim backend show --resource-group MyResourceGroup --service-name MyServiceName --backend-id MyBackendId

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

--backend-id

Идентификатор серверной части.

Свойство	Значение
Группа параметров:	Backend Arguments

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

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

az apim backend update

Изменить

Обновите серверную часть управления API.

az apim backend update --backend-id
                       --resource-group
                       --service-name
                       [--acquire-policy-token]
                       [--add]
                       [--change-reference]
                       [--description]
                       [--force-string]
                       [--if-match]
                       [--protocol {http, soap}]
                       [--remove]
                       [--set]
                       [--url]

Примеры

Обновление серверной части.

az apim backend update --service-name MyApim -g MyResourceGroup --backend-id MyBackendId --url https://mynewbackend.com

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

--backend-id

Уникальное имя серверной части для обновления.

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

Свойство	Значение
Группа параметров:	Backend Arguments

--resource-group -g

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

--service-name -n

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

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

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

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

--force-string

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

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

--if-match

ETag объекта. Не требуется при создании сущности, но требуется при обновлении сущности. Значение по умолчанию — None.

--protocol

Протокол, используемый для взаимодействия с серверной службой. Возможные значения: http, soap.

Свойство	Значение
Допустимые значения:	http, soap

--remove

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

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

--set

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

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

--url

URL-адрес серверной службы.

Глобальные параметры

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

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

Обратная связь

Были ли сведения на этой странице полезными?