az apic environment
참고 항목
이 참조는 Azure CLI(버전 2.57.0 이상)에 대한 apic 확장 확장의 일부입니다. az apic environment 명령을 처음 실행할 때 확장이 자동으로 설치됩니다. 확장 프로그램에 대해 자세히 알아보세요.
API 센터에서 환경을 관리하는 명령입니다.
명령
| Name | Description | 형식 | 상태 |
|---|---|---|---|
| az apic environment create |
새 환경을 만들거나 기존 환경을 업데이트합니다. |
내선 번호 | GA |
| az apic environment delete |
환경을 삭제합니다. |
내선 번호 | GA |
| az apic environment list |
환경 컬렉션을 나열합니다. |
내선 번호 | GA |
| az apic environment show |
환경의 세부 정보를 가져옵니다. |
내선 번호 | GA |
| az apic environment update |
기존 환경을 업데이트합니다. |
내선 번호 | GA |
az apic environment create
새 환경을 만들거나 기존 환경을 업데이트합니다.
az apic environment create --environment-id
--resource-group
--service-name
--title
--type {development, production, staging, testing}
[--custom-properties]
[--description]
[--onboarding]
[--server]예제
환경 만들기
az apic environment create -g api-center-test -n contosoeuap --environment-id public --title "Public cloud" --type "development"필수 매개 변수
환경의 ID입니다.
리소스 그룹의 이름입니다. az configure --defaults group=<name>을 사용하여 기본 그룹을 구성할 수 있습니다.
Azure API Center 서비스의 이름입니다.
환경 제목입니다.
환경 유형입니다.
선택적 매개 변수
API 카탈로그 엔터티에 대해 정의된 사용자 지정 메타데이터입니다. json-file 및 yaml-file을 지원합니다.
환경 설명입니다.
사용자 환경과 관련된 온보딩 설명서(예: {developerPortalUri:[''https://developer.contoso.com],instructions:'instructions markdown'} Support shorthand-syntax, json-file 및 yaml-file)를 제공합니다. 더 많은 것을 표시하려면 "??"를 시도해 보세요.
환경의 서버 정보입니다. 약식 구문, json-file 및 yaml-file을 지원합니다. 더 많은 것을 표시하려면 "??"를 시도해 보세요.
전역 매개 변수
로깅의 자세한 정도를 늘려 모든 디버그 로그를 표시합니다.
이 도움말 메시지를 표시하고 종료합니다.
오류만 표시하고, 경고를 표시하지 않습니다.
출력 형식입니다.
JMESPath 쿼리 문자열입니다. 자세한 내용과 예제는 http://jmespath.org/를 참조하세요.
구독의 이름 또는 ID입니다. az account set -s NAME_OR_ID를 사용하여 기본 위치를 구성할 수 있습니다.
로깅의 자세한 정도를 늘립니다. 전체 디버그 로그를 표시하려면 --debug를 사용합니다.
az apic environment delete
환경을 삭제합니다.
az apic environment delete [--environment-id]
[--ids]
[--resource-group]
[--service-name]
[--subscription]
[--yes]예제
환경 삭제
az apic environment delete -g api-center-test -n contosoeuap --environment-id public선택적 매개 변수
환경의 ID입니다.
하나 이상의 리소스 ID(공백으로 구분)입니다. '리소스 ID' 인수의 모든 정보를 포함하는 완전한 리소스 ID여야 합니다. --ids 또는 기타 '리소스 ID' 인수를 제공해야 합니다.
리소스 그룹의 이름입니다. az configure --defaults group=<name>을 사용하여 기본 그룹을 구성할 수 있습니다.
Azure API Center 서비스의 이름입니다.
구독의 이름 또는 ID입니다. az account set -s NAME_OR_ID를 사용하여 기본 위치를 구성할 수 있습니다.
확인을 묻는 메시지를 표시하지 마세요.
전역 매개 변수
로깅의 자세한 정도를 늘려 모든 디버그 로그를 표시합니다.
이 도움말 메시지를 표시하고 종료합니다.
오류만 표시하고, 경고를 표시하지 않습니다.
출력 형식입니다.
JMESPath 쿼리 문자열입니다. 자세한 내용과 예제는 http://jmespath.org/를 참조하세요.
구독의 이름 또는 ID입니다. az account set -s NAME_OR_ID를 사용하여 기본 위치를 구성할 수 있습니다.
로깅의 자세한 정도를 늘립니다. 전체 디버그 로그를 표시하려면 --debug를 사용합니다.
az apic environment list
환경 컬렉션을 나열합니다.
az apic environment list --resource-group
--service-name
[--filter]
[--max-items]
[--next-token]예제
환경 나열
az apic environment list -g api-center-test -n contosoeuap필수 매개 변수
리소스 그룹의 이름입니다. az configure --defaults group=<name>을 사용하여 기본 그룹을 구성할 수 있습니다.
Azure API Center 서비스의 이름입니다.
선택적 매개 변수
OData 필터 매개 변수입니다.
명령의 출력에서 반환할 총 항목 수입니다. 사용 가능한 총 항목 수가 지정된 값보다 많으면 명령의 출력에 토큰이 제공됩니다. 페이지 매김을 다시 시작하려면 후속 명령의 인수에 --next-token 토큰 값을 제공합니다.
페이지 매김을 시작할 위치를 지정하는 토큰입니다. 이는 이전에 잘린 응답의 토큰 값입니다.
전역 매개 변수
로깅의 자세한 정도를 늘려 모든 디버그 로그를 표시합니다.
이 도움말 메시지를 표시하고 종료합니다.
오류만 표시하고, 경고를 표시하지 않습니다.
출력 형식입니다.
JMESPath 쿼리 문자열입니다. 자세한 내용과 예제는 http://jmespath.org/를 참조하세요.
구독의 이름 또는 ID입니다. az account set -s NAME_OR_ID를 사용하여 기본 위치를 구성할 수 있습니다.
로깅의 자세한 정도를 늘립니다. 전체 디버그 로그를 표시하려면 --debug를 사용합니다.
az apic environment show
환경의 세부 정보를 가져옵니다.
az apic environment show [--environment-id]
[--ids]
[--resource-group]
[--service-name]
[--subscription]예제
환경 세부 정보 표시
az apic environment show -g api-center-test -n contosoeuap --environment-id public선택적 매개 변수
환경의 ID입니다.
하나 이상의 리소스 ID(공백으로 구분)입니다. '리소스 ID' 인수의 모든 정보를 포함하는 완전한 리소스 ID여야 합니다. --ids 또는 기타 '리소스 ID' 인수를 제공해야 합니다.
리소스 그룹의 이름입니다. az configure --defaults group=<name>을 사용하여 기본 그룹을 구성할 수 있습니다.
Azure API Center 서비스의 이름입니다.
구독의 이름 또는 ID입니다. az account set -s NAME_OR_ID를 사용하여 기본 위치를 구성할 수 있습니다.
전역 매개 변수
로깅의 자세한 정도를 늘려 모든 디버그 로그를 표시합니다.
이 도움말 메시지를 표시하고 종료합니다.
오류만 표시하고, 경고를 표시하지 않습니다.
출력 형식입니다.
JMESPath 쿼리 문자열입니다. 자세한 내용과 예제는 http://jmespath.org/를 참조하세요.
구독의 이름 또는 ID입니다. az account set -s NAME_OR_ID를 사용하여 기본 위치를 구성할 수 있습니다.
로깅의 자세한 정도를 늘립니다. 전체 디버그 로그를 표시하려면 --debug를 사용합니다.
az apic environment update
기존 환경을 업데이트합니다.
az apic environment update [--add]
[--custom-properties]
[--description]
[--environment-id]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--onboarding]
[--remove]
[--resource-group]
[--server]
[--service-name]
[--set]
[--subscription]
[--title]
[--type {development, production, staging, testing}]예제
업데이트 환경
az apic environment update -g api-center-test -n contosoeuap --environment-id public --title "Public cloud"선택적 매개 변수
경로 및 키 값 쌍을 지정하여 개체 목록에 개체를 추가합니다. 예: --add property.listProperty <key=value, string 또는 JSON 문자열>.
API 카탈로그 엔터티에 대해 정의된 사용자 지정 메타데이터입니다. json-file 및 yaml-file을 지원합니다.
설명.
환경의 ID입니다.
'set' 또는 'add'를 사용하는 경우 JSON으로 변환하는 대신 문자열 리터럴을 유지합니다.
하나 이상의 리소스 ID(공백으로 구분)입니다. '리소스 ID' 인수의 모든 정보를 포함하는 완전한 리소스 ID여야 합니다. --ids 또는 기타 '리소스 ID' 인수를 제공해야 합니다.
{developerPortalUri:[''https://developer.contoso.com],instructions:'instructions markdown'} shorthand-syntax, json-file 및 yaml-file을 지원합니다. 더 많은 것을 표시하려면 "??"를 시도해 보세요.
목록에서 속성 또는 요소를 제거합니다. 예: --remove property.list OR --remove propertyToRemove.
리소스 그룹의 이름입니다. az configure --defaults group=<name>을 사용하여 기본 그룹을 구성할 수 있습니다.
환경의 서버 정보입니다. 약식 구문, json-file 및 yaml-file을 지원합니다. 더 많은 것을 표시하려면 "??"를 시도해 보세요.
Azure API Center 서비스의 이름입니다.
설정할 속성 경로와 값을 지정하여 개체를 업데이트합니다. 예: --set property1.property2=.
구독의 이름 또는 ID입니다. az account set -s NAME_OR_ID를 사용하여 기본 위치를 구성할 수 있습니다.
환경 제목입니다.
환경 유형입니다.
전역 매개 변수
로깅의 자세한 정도를 늘려 모든 디버그 로그를 표시합니다.
이 도움말 메시지를 표시하고 종료합니다.
오류만 표시하고, 경고를 표시하지 않습니다.
출력 형식입니다.
JMESPath 쿼리 문자열입니다. 자세한 내용과 예제는 http://jmespath.org/를 참조하세요.
구독의 이름 또는 ID입니다. az account set -s NAME_OR_ID를 사용하여 기본 위치를 구성할 수 있습니다.
로깅의 자세한 정도를 늘립니다. 전체 디버그 로그를 표시하려면 --debug를 사용합니다.
Azure CLI