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


az spring gateway

Примечание.

Эта ссылка является частью расширения spring для Azure CLI (версия 2.56.0 или более поздней). Расширение автоматически установит первый раз, когда вы запускаете команду az spring gateway. Подробнее о расширениях.

Эта группа команд неявно устарела, так как группа команд Spring устарела и будет удалена в будущем выпуске.

(Только корпоративный уровень) Команды для управления шлюзом в Azure Spring Apps.

Команды

Имя Описание Тип Состояние
az spring gateway clear

Снимите все параметры шлюза.

Расширение Deprecated
az spring gateway create

Создание шлюза Spring Cloud.

Расширение Deprecated
az spring gateway custom-domain

Команды для управления пользовательскими доменами для шлюза.

Расширение Deprecated
az spring gateway custom-domain bind

Привязка личного домена к шлюзу.

Расширение Deprecated
az spring gateway custom-domain list

Список всех пользовательских доменов шлюза.

Расширение Deprecated
az spring gateway custom-domain show

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

Расширение Deprecated
az spring gateway custom-domain unbind

Отмена привязки личного домена шлюза.

Расширение Deprecated
az spring gateway custom-domain update

Обновите личный домен шлюза.

Расширение Deprecated
az spring gateway delete

Удаление Шлюза Spring Cloud.

Расширение Deprecated
az spring gateway restart

Перезапустите шлюз Spring Cloud.

Расширение Deprecated
az spring gateway route-config

Команды для управления конфигурациями маршрутов шлюза в Azure Spring Apps.

Расширение Deprecated
az spring gateway route-config create

Создайте конфигурацию маршрута шлюза с правилами маршрутизации формата массива Json.

Расширение Deprecated
az spring gateway route-config list

Перечислить все существующие конфигурации маршрутов шлюза.

Расширение Deprecated
az spring gateway route-config remove

Удалите существующую конфигурацию маршрута шлюза.

Расширение Deprecated
az spring gateway route-config show

Получите существующую конфигурацию маршрута шлюза.

Расширение Deprecated
az spring gateway route-config update

Обновите существующую конфигурацию маршрута шлюза с помощью правил маршрутизации формата массива Json.

Расширение Deprecated
az spring gateway show

Отображение параметров, состояния подготовки и состояния среды выполнения шлюза.

Расширение Deprecated
az spring gateway sync-cert

Синхронизация сертификата шлюза.

Расширение Deprecated
az spring gateway update

Обновите существующие свойства шлюза.

Расширение Deprecated

az spring gateway clear

Не рекомендуется

Эта команда неявно устарела, так как группа команд Spring устарела и будет удалена в будущем выпуске.

Снимите все параметры шлюза.

az spring gateway clear --resource-group
                        --service
                        [--no-wait]

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

--resource-group -g

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

--service -s

Имя экземпляра Azure Spring Apps можно настроить службу по умолчанию с помощью az configure --defaults spring=<name>.

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

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

--no-wait

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

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

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

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

az spring gateway create

Не рекомендуется

Эта команда неявно устарела, так как группа команд Spring устарела и будет удалена в будущем выпуске.

Создание шлюза Spring Cloud.

az spring gateway create --resource-group
                         --service
                         [--instance-count]

Примеры

Создание шлюза Spring Cloud.

az spring gateway create -s MyService -g MyResourceGroup --instance-count 2

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

--resource-group -g

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

--service -s

Имя экземпляра Azure Spring Apps можно настроить службу по умолчанию с помощью az configure --defaults spring=<name>.

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

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

--instance-count

Количество экземпляров.

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

Не рекомендуется

Эта команда неявно устарела, так как группа команд Spring устарела и будет удалена в будущем выпуске.

Удаление Шлюза Spring Cloud.

az spring gateway delete --resource-group
                         --service
                         [--yes]

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

--resource-group -g

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

--service -s

Имя экземпляра Azure Spring Apps можно настроить службу по умолчанию с помощью az configure --defaults spring=<name>.

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

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

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

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

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

az spring gateway restart

Не рекомендуется

Эта команда неявно устарела, так как группа команд Spring устарела и будет удалена в будущем выпуске.

Перезапустите шлюз Spring Cloud.

az spring gateway restart --resource-group
                          --service
                          [--no-wait]
                          [--yes]

Примеры

Перезапустите шлюз Spring Cloud.

az spring gateway restart -s MyService -g MyResourceGroup

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

--resource-group -g

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

--service -s

Имя экземпляра Azure Spring Apps можно настроить службу по умолчанию с помощью az configure --defaults spring=<name>.

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

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

--no-wait

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

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

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

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

az spring gateway show

Не рекомендуется

Эта команда неявно устарела, так как группа команд Spring устарела и будет удалена в будущем выпуске.

Отображение параметров, состояния подготовки и состояния среды выполнения шлюза.

az spring gateway show --resource-group
                       --service

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

--resource-group -g

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

--service -s

Имя экземпляра Azure Spring Apps можно настроить службу по умолчанию с помощью az configure --defaults spring=<name>.

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

Не рекомендуется

Эта команда неявно устарела, так как группа команд Spring устарела и будет удалена в будущем выпуске.

Синхронизация сертификата шлюза.

az spring gateway sync-cert --resource-group
                            --service
                            [--no-wait]
                            [--yes]

Примеры

Синхронизация сертификата шлюза.

az spring gateway sync-cert -s MyService -g MyResourceGroup

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

--resource-group -g

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

--service -s

Имя экземпляра Azure Spring Apps можно настроить службу по умолчанию с помощью az configure --defaults spring=<name>.

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

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

--no-wait

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

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

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

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

az spring gateway update

Не рекомендуется

Эта команда неявно устарела, так как группа команд Spring устарела и будет удалена в будущем выпуске.

Обновите существующие свойства шлюза.

az spring gateway update --resource-group
                         --service
                         [--addon-configs-file]
                         [--addon-configs-json]
                         [--allow-credentials {false, true}]
                         [--allow-origin-patterns --allowed-origin-patterns]
                         [--allowed-headers]
                         [--allowed-methods]
                         [--allowed-origins]
                         [--api-description]
                         [--api-doc-location]
                         [--api-title]
                         [--api-version]
                         [--apm-types]
                         [--apms]
                         [--assign-endpoint {false, true}]
                         [--certificate-names]
                         [--client-id]
                         [--client-secret]
                         [--cpu]
                         [--enable-cert-verify --enable-certificate-verification {false, true}]
                         [--enable-response-cache {false, true}]
                         [--exposed-headers]
                         [--https-only {false, true}]
                         [--instance-count]
                         [--issuer-uri]
                         [--max-age]
                         [--memory]
                         [--no-wait]
                         [--properties]
                         [--response-cache-scope]
                         [--response-cache-size]
                         [--response-cache-ttl]
                         [--scope]
                         [--secrets]
                         [--server-url]

Примеры

Обновление свойства шлюза.

az spring gateway update -s MyService -g MyResourceGroup --assign-endpoint true --https-only true

Включите и настройте кэш ответов на уровне маршрута и задайте значение ttl до 5 минут.

az spring gateway update -s MyService -g MyResourceGroup --enable-response-cache --response-cache-scope Route --response-cache-ttl 5m

Если кэш ответов включен, обновите срок действия до 3 минут.

az spring gateway update -s MyService -g MyResourceGroup --response-cache-ttl 3m

Отключите кэш ответов.

az spring gateway update -s MyService -g MyResourceGroup --enable-response-cache false

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

--resource-group -g

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

--service -s

Имя экземпляра Azure Spring Apps можно настроить службу по умолчанию с помощью az configure --defaults spring=<name>.

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

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

--addon-configs-file

Путь к файлу строки JSON конфигураций надстроек.

Свойство Значение
Группа параметров: Add-on Configurations Arguments
--addon-configs-json

Строка JSON конфигураций надстроек.

Свойство Значение
Группа параметров: Add-on Configurations Arguments
--allow-credentials

Поддерживаются ли учетные данные пользователя на межсайтовых запросах.

Свойство Значение
Группа параметров: Cross-origin Resource Sharing (CORS) Arguments
Допустимые значения: false, true
--allow-origin-patterns --allowed-origin-patterns

Разделенный запятыми список разрешенных шаблонов источника для выполнения межсайтовых запросов.

Свойство Значение
Группа параметров: Cross-origin Resource Sharing (CORS) Arguments
--allowed-headers

Разделенный запятыми список разрешенных заголовков в межсайтовых запросах. Специальное значение * позволяет фактическим запросам отправлять любой заголовок.

Свойство Значение
Группа параметров: Cross-origin Resource Sharing (CORS) Arguments
--allowed-methods

Разделенный запятыми список разрешенных методов HTTP для запросов между сайтами. Специальное значение * разрешает все методы.

Свойство Значение
Группа параметров: Cross-origin Resource Sharing (CORS) Arguments
--allowed-origins

Разделенный запятыми список разрешенных источников для выполнения межсайтовых запросов. Специальное значение * разрешает все домены.

Свойство Значение
Группа параметров: Cross-origin Resource Sharing (CORS) Arguments
--api-description

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

Свойство Значение
Группа параметров: API metadata Arguments
--api-doc-location

Расположение дополнительной документации для API, доступных в экземпляре шлюза.

Свойство Значение
Группа параметров: API metadata Arguments
--api-title

Заголовок, описывающий контекст API, доступных в экземпляре шлюза.

Свойство Значение
Группа параметров: API metadata Arguments
--api-version

Версия API, доступная в этом экземпляре шлюза.

Свойство Значение
Группа параметров: API metadata Arguments
--apm-types

Разделенный пробелами список APM, интегрированный с шлюзом. Допустимые значения: ApplicationInsights, AppDynamics, Dynatrace, NewRelic, ElasticAPM.

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

Разделенный пробелами список ссылочных имен APM в Azure Spring Apps для интеграции с Шлюзом.

Свойство Значение
Группа параметров: APM Arguments
--assign-endpoint

Если значение true, назначьте URL-адрес конечной точки для прямого доступа.

Свойство Значение
Допустимые значения: false, true
--certificate-names

Разделенный запятыми список имен сертификатов в Azure Spring Apps.

Свойство Значение
Группа параметров: Client Certificate Authentication Arguments
--client-id

Общедоступный идентификатор приложения.

Свойство Значение
Группа параметров: Single Sign On (SSO) Arguments
--client-secret

Секрет, известный только приложению и серверу авторизации.

Свойство Значение
Группа параметров: Single Sign On (SSO) Arguments
--cpu

Количество ресурсов ЦП. Должно быть 500 м или число ядер ЦП.

--enable-cert-verify --enable-certificate-verification

Если значение true, убедитесь, что сертификат в tls-подключении из шлюза к приложению.

Свойство Значение
Группа параметров: Client Certificate Authentication Arguments
Допустимые значения: false, true
--enable-response-cache

Включите параметры кэша ответов в Spring Cloud Gateway.

Свойство Значение
Группа параметров: Response Cache Arguments
Допустимые значения: false, true
--exposed-headers

Разделенный запятыми список заголовков ответов HTTP для предоставления запросов между сайтами.

Свойство Значение
Группа параметров: Cross-origin Resource Sharing (CORS) Arguments
--https-only

Если значение true, конечная точка доступа через https.

Свойство Значение
Допустимые значения: false, true
--instance-count

Количество экземпляров.

--issuer-uri

Универсальный код ресурса (URI) идентификатора издателя.

Свойство Значение
Группа параметров: Single Sign On (SSO) Arguments
--max-age

Сколько времени, в секундах, ответ от запроса перед полетом может кэшироваться клиентами.

Свойство Значение
Группа параметров: Cross-origin Resource Sharing (CORS) Arguments
--memory

Количество ресурсов памяти. Должно быть 512Mi или #Gi, например 1Gi, 3Gi.

--no-wait

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

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

Нечувствительные свойства для переменных среды. Формат "key[=value]" и разделенный пробелом.

--response-cache-scope

Область для кэша ответов, доступные значения: [Route, Instance].

Свойство Значение
Группа параметров: Response Cache Arguments
--response-cache-size

Максимальный размер кэша, который определяет, требуется ли вытеснить некоторые записи. Примерами являются [1 ГБ, 10 МБ, 100 КБ]. Используйте значение по умолчанию для сброса, а шлюз будет управлять этим свойством.

Свойство Значение
Группа параметров: Response Cache Arguments
--response-cache-ttl

Время до истечения срока действия кэшированного входа. Примеры: [1h, 30m, 50s]. Используйте значение по умолчанию для сброса, а шлюз будет управлять этим свойством.

Свойство Значение
Группа параметров: Response Cache Arguments
--scope

Разделенный запятыми список конкретных приложений действий можно выполнять от имени пользователя.

Свойство Значение
Группа параметров: Single Sign On (SSO) Arguments
--secrets

Конфиденциальные свойства переменных среды. После установки он будет зашифрован и не возвращен. Формат "key[=value]" и разделенный пробелом.

--server-url

Базовый URL-адрес, используемый потребителями API для доступа к API на экземпляре шлюза.

Свойство Значение
Группа параметров: API metadata Arguments
Глобальные параметры
--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