다음을 통해 공유

az spring api-portal

  • 참조

메모

이 참조는 Azure CLI(버전 2.56.0 이상)에 대한 spring 확장의 일부입니다. az spring api-portal 명령을 처음 실행할 때 확장이 자동으로 설치됩니다. 확장에 대한 자세한 알아봅니다.

(엔터프라이즈 계층에만 해당) Azure Spring Apps에서 API 포털을 관리하는 명령입니다.

명령

Name Description 형식 상태
az spring api-portal clear

API 포털의 모든 설정을 지웁니다.

 확장 조지아
az spring api-portal create

API 포털을 만듭니다.

 확장 조지아
az spring api-portal custom-domain

API 포털에 대한 사용자 지정 도메인을 관리하는 명령입니다.

 확장 조지아
az spring api-portal custom-domain bind

API 포털을 사용하여 사용자 지정 도메인을 바인딩합니다.

 확장 조지아
az spring api-portal custom-domain list

API 포털의 모든 사용자 지정 도메인을 나열합니다.

 확장 조지아
az spring api-portal custom-domain show

사용자 지정 도메인의 세부 정보를 표시합니다.

 확장 조지아
az spring api-portal custom-domain unbind

API 포털의 사용자 지정 도메인을 바인딩 해제합니다.

 확장 조지아
az spring api-portal custom-domain update

API 포털의 사용자 지정 도메인을 업데이트합니다.

 확장 조지아
az spring api-portal delete

API 포털을 삭제합니다.

 확장 조지아
az spring api-portal show

API 포털의 설정, 프로비전 상태 및 런타임 상태를 표시합니다.

 확장 조지아
az spring api-portal update

기존 API 포털 속성을 업데이트합니다.

 확장 조지아

az spring api-portal clear

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

로깅 세부 정보를 늘려 모든 디버그 로그를 표시합니다.

--help -h

이 도움말 메시지를 표시하고 종료합니다.

--only-show-errors

경고를 표시하지 않고 오류만 표시합니다.

--output -o

출력 형식입니다.

허용되는 값: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath 쿼리 문자열입니다. 자세한 내용 및 예제는 http://jmespath.org/ 참조하세요.

--subscription

구독의 이름 또는 ID입니다. az account set -s NAME_OR_ID사용하여 기본 구독을 구성할 수 있습니다.

--verbose

로깅 세부 정보를 늘립니다. 전체 디버그 로그에 --debug를 사용합니다.

az spring api-portal create

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

로깅 세부 정보를 늘려 모든 디버그 로그를 표시합니다.

--help -h

이 도움말 메시지를 표시하고 종료합니다.

--only-show-errors

경고를 표시하지 않고 오류만 표시합니다.

--output -o

출력 형식입니다.

허용되는 값: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath 쿼리 문자열입니다. 자세한 내용 및 예제는 http://jmespath.org/ 참조하세요.

--subscription

구독의 이름 또는 ID입니다. az account set -s NAME_OR_ID사용하여 기본 구독을 구성할 수 있습니다.

--verbose

로깅 세부 정보를 늘립니다. 전체 디버그 로그에 --debug를 사용합니다.

az spring api-portal delete

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

로깅 세부 정보를 늘려 모든 디버그 로그를 표시합니다.

--help -h

이 도움말 메시지를 표시하고 종료합니다.

--only-show-errors

경고를 표시하지 않고 오류만 표시합니다.

--output -o

출력 형식입니다.

허용되는 값: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath 쿼리 문자열입니다. 자세한 내용 및 예제는 http://jmespath.org/ 참조하세요.

--subscription

구독의 이름 또는 ID입니다. az account set -s NAME_OR_ID사용하여 기본 구독을 구성할 수 있습니다.

--verbose

로깅 세부 정보를 늘립니다. 전체 디버그 로그에 --debug를 사용합니다.

az spring api-portal show

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

로깅 세부 정보를 늘려 모든 디버그 로그를 표시합니다.

--help -h

이 도움말 메시지를 표시하고 종료합니다.

--only-show-errors

경고를 표시하지 않고 오류만 표시합니다.

--output -o

출력 형식입니다.

허용되는 값: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath 쿼리 문자열입니다. 자세한 내용 및 예제는 http://jmespath.org/ 참조하세요.

--subscription

구독의 이름 또는 ID입니다. az account set -s NAME_OR_ID사용하여 기본 구독을 구성할 수 있습니다.

--verbose

로깅 세부 정보를 늘립니다. 전체 디버그 로그에 --debug를 사용합니다.

az spring api-portal update

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

애플리케이션의 공용 식별자입니다.

--client-secret

애플리케이션 및 권한 부여 서버에만 알려진 비밀입니다.

--enable-api-try-out

API 포털에서 요청을 보내고 응답을 확인하여 API를 사용해 보세요.

허용되는 값: false, true
--https-only

true이면 https를 통해 엔드포인트에 액세스합니다.

허용되는 값: false, true
--instance-count

인스턴스 수입니다.

--issuer-uri

발급자 식별자의 URI입니다.

--scope

쉼표로 구분된 특정 작업 애플리케이션 목록은 사용자를 대신하여 수행할 수 있습니다.

전역 매개 변수
--debug

로깅 세부 정보를 늘려 모든 디버그 로그를 표시합니다.

--help -h

이 도움말 메시지를 표시하고 종료합니다.

--only-show-errors

경고를 표시하지 않고 오류만 표시합니다.

--output -o

출력 형식입니다.

허용되는 값: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath 쿼리 문자열입니다. 자세한 내용 및 예제는 http://jmespath.org/ 참조하세요.

--subscription

구독의 이름 또는 ID입니다. az account set -s NAME_OR_ID사용하여 기본 구독을 구성할 수 있습니다.

--verbose

로깅 세부 정보를 늘립니다. 전체 디버그 로그에 --debug를 사용합니다.