az spring api-portal

Примечание.

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

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

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

Команды

Имя	Описание	Тип	Состояние
az spring api-portal clear	Снимите все параметры портала API.	Расширение	Deprecated
az spring api-portal create	Создание портала API.	Расширение	Deprecated
az spring api-portal custom-domain	Команды для управления пользовательскими доменами на портале API.	Расширение	Deprecated
az spring api-portal custom-domain bind	Привязка личного домена к порталу API.	Расширение	Deprecated
az spring api-portal custom-domain list	Список всех пользовательских доменов портала API.	Расширение	Deprecated
az spring api-portal custom-domain show	Отображение сведений о пользовательском домене.	Расширение	Deprecated
az spring api-portal custom-domain unbind	Отмена привязки личного домена портала API.	Расширение	Deprecated
az spring api-portal custom-domain update	Обновите личный домен портала API.	Расширение	Deprecated
az spring api-portal delete	Удаление портала API.	Расширение	Deprecated
az spring api-portal show	Отображение параметров, состояния подготовки и состояния среды выполнения портала API.	Расширение	Deprecated
az spring api-portal update	Обновите существующие свойства портала API.	Расширение	Deprecated

az spring api-portal clear

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

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

Снимите все параметры портала API.

az spring api-portal clear --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 api-portal create

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

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

Создание портала API.

az spring api-portal create --resource-group
                            --service
                            [--instance-count]

Примеры

Создание портала API.

az spring api-portal create -s MyService -g MyResourceGroup --instance-count 1

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

--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 api-portal delete

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

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

Удаление портала API.

az spring api-portal 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 api-portal show

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

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

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

az spring api-portal 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 api-portal update

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

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

Обновите существующие свойства портала API.

az spring api-portal update --resource-group
                            --service
                            [--assign-endpoint {false, true}]
                            [--client-id]
                            [--client-secret]
                            [--enable-api-try-out {false, true}]
                            [--https-only {false, true}]
                            [--instance-count]
                            [--issuer-uri]
                            [--scope]

Примеры

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

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

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

--resource-group -g

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

--service -s

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

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

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

--assign-endpoint

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

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

--client-id

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

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

--client-secret

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

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

--enable-api-try-out

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

Свойство	Значение
Группа параметров:	Try out API Arguments
Допустимые значения:	false, true

--https-only

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

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

--instance-count

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

--issuer-uri

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

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

--scope

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

Свойство	Значение
Группа параметров:	Single Sign On (SSO) 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