az apic api
Note
This reference is part of the apic-extension extension for the Azure CLI (version 2.57.0 or higher). az apic api 명령을 처음 실행할 때 확장이 자동으로 설치됩니다. Learn more about extensions.
API 센터에서 API를 관리하는 명령입니다.
명령
Name | Description | 형식 | 상태 |
---|---|---|---|
az apic api create |
새 API를 등록하거나 기존 API를 업데이트합니다. |
Extension | GA |
az apic api definition |
API 센터에서 API 정의를 관리하는 명령입니다. |
Extension | GA |
az apic api definition create |
새 API 정의를 만들거나 기존 API 정의를 업데이트합니다. |
Extension | GA |
az apic api definition delete |
지정된 API 정의를 삭제합니다. |
Extension | GA |
az apic api definition export-specification |
API 사양을 내보냅니다. |
Extension | GA |
az apic api definition import-specification |
API 사양을 가져옵니다. |
Extension | GA |
az apic api definition list |
API 정의 컬렉션을 나열합니다. |
Extension | GA |
az apic api definition show |
API 정의에 대한 세부 정보를 가져옵니다. |
Extension | GA |
az apic api definition update |
기존 API 정의를 업데이트합니다. |
Extension | GA |
az apic api delete |
지정된 API를 삭제합니다. |
Extension | GA |
az apic api deployment |
API 센터에서 API 배포를 관리하는 명령입니다. |
Extension | GA |
az apic api deployment create |
새 API 배포를 만들거나 기존 API 배포를 업데이트합니다. |
Extension | GA |
az apic api deployment delete |
API 배포를 삭제합니다. |
Extension | GA |
az apic api deployment list |
API 배포의 컬렉션을 나열합니다. |
Extension | GA |
az apic api deployment show |
API 배포에 대한 세부 정보를 가져옵니다. |
Extension | GA |
az apic api deployment update |
기존 API 배포를 업데이트합니다. |
Extension | GA |
az apic api list |
API 컬렉션을 나열합니다. |
Extension | GA |
az apic api register |
사양 파일을 진리 원본으로 사용하여 버전, 정의 및 관련 배포에 새 API를 등록합니다. 지금은 OpenAPI JSON/YAML 형식만 지원합니다. |
Extension | Preview |
az apic api show |
API의 세부 정보를 가져옵니다. |
Extension | GA |
az apic api update |
기존 API를 업데이트합니다. |
Extension | GA |
az apic api version |
API 센터에서 API 버전을 관리하는 명령입니다. |
Extension | GA |
az apic api version create |
새 API 버전을 만들거나 기존 API 버전을 업데이트합니다. |
Extension | GA |
az apic api version delete |
지정된 API 버전을 삭제합니다. |
Extension | GA |
az apic api version list |
API 버전의 컬렉션을 나열합니다. |
Extension | GA |
az apic api version show |
API 버전의 세부 정보를 가져옵니다. |
Extension | GA |
az apic api version update |
기존 API 버전을 업데이트합니다. |
Extension | GA |
az apic api create
새 API를 등록하거나 기존 API를 업데이트합니다.
az apic api create --api-id
--resource-group
--service-name
--title
--type {graphql, grpc, rest, soap, webhook, websocket}
[--contacts]
[--custom-properties]
[--description]
[--external-documentation]
[--license]
[--summary]
예제
Create API
az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST
사용자 지정 속성을 사용하여 API 만들기
az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '{"public-facing":true}'
json 파일을 사용하여 사용자 지정 속성을 사용하여 API 만들기
az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '@customProperties.json'
필수 매개 변수
API의 ID입니다.
리소스 그룹의 이름입니다.
az configure --defaults group=<name>
사용하여 기본 그룹을 구성할 수 있습니다.
Azure API Center 서비스의 이름입니다.
API title.
속성 | 값 |
---|---|
Parameter group: | Properties Arguments |
API의 유형입니다.
속성 | 값 |
---|---|
Parameter group: | Properties Arguments |
허용되는 값: | graphql, grpc, rest, soap, webhook, websocket |
선택적 매개 변수
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
API에 대한 연락처 정보입니다. 약식 구문, json-file 및 yaml-file을 지원합니다. 더 많은 것을 표시하려면 "??"를 시도해 보세요.
속성 | 값 |
---|---|
Parameter group: | Properties Arguments |
API 카탈로그 엔터티에 대해 정의된 사용자 지정 메타데이터입니다. 약식 구문, json-file 및 yaml-file을 지원합니다. 더 많은 것을 표시하려면 "??"를 시도해 보세요.
속성 | 값 |
---|---|
Parameter group: | Properties Arguments |
API에 대한 설명입니다.
속성 | 값 |
---|---|
Parameter group: | Properties Arguments |
API에 대한 추가 외부 설명서입니다. 약식 구문, json-file 및 yaml-file을 지원합니다. 더 많은 것을 표시하려면 "??"를 시도해 보세요.
속성 | 값 |
---|---|
Parameter group: | Properties Arguments |
API에 대한 라이선스 정보입니다. 약식 구문, json-file 및 yaml-file을 지원합니다. 더 많은 것을 표시하려면 "??"를 시도해 보세요.
속성 | 값 |
---|---|
Parameter group: | Properties Arguments |
API에 대한 간단한 설명입니다.
속성 | 값 |
---|---|
Parameter group: | Properties Arguments |
전역 매개 변수
로깅 수위를 높여 모든 디버그 로그를 표시합니다.
속성 | 값 |
---|---|
Default value: | False |
이 도움말 메시지를 표시하고 종료합니다.
경고를 표시하지 않고 오류만 표시합니다.
속성 | 값 |
---|---|
Default value: | False |
Output format.
속성 | 값 |
---|---|
Default value: | json |
허용되는 값: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 쿼리 문자열입니다. 자세한 내용 및 예제는 http://jmespath.org/ 참조하세요.
구독의 이름 또는 ID입니다.
az account set -s NAME_OR_ID
사용하여 기본 구독을 구성할 수 있습니다.
로깅의 자세한 정도를 증가시킵니다. 전체 디버그 로그에 --debug를 사용합니다.
속성 | 값 |
---|---|
Default value: | False |
az apic api delete
지정된 API를 삭제합니다.
az apic api delete [--api-id]
[--ids]
[--resource-group]
[--service-name]
[--subscription]
[--yes]
예제
Delete API
az apic api delete -g contoso-resources -n contoso --api-id echo-api
선택적 매개 변수
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
API의 ID입니다.
속성 | 값 |
---|---|
Parameter group: | Resource Id Arguments |
하나 이상의 리소스 ID(공백으로 구분). '리소스 ID' 인수의 모든 정보를 포함하는 전체 리소스 ID여야 합니다. --ids 또는 다른 '리소스 ID' 인수를 제공해야 합니다.
속성 | 값 |
---|---|
Parameter group: | Resource Id Arguments |
리소스 그룹의 이름입니다.
az configure --defaults group=<name>
사용하여 기본 그룹을 구성할 수 있습니다.
속성 | 값 |
---|---|
Parameter group: | Resource Id Arguments |
Azure API Center 서비스의 이름입니다.
속성 | 값 |
---|---|
Parameter group: | Resource Id Arguments |
구독의 이름 또는 ID입니다.
az account set -s NAME_OR_ID
사용하여 기본 구독을 구성할 수 있습니다.
속성 | 값 |
---|---|
Parameter group: | Resource Id Arguments |
확인 메시지를 표시하지 않습니다.
속성 | 값 |
---|---|
Default value: | False |
전역 매개 변수
로깅 수위를 높여 모든 디버그 로그를 표시합니다.
속성 | 값 |
---|---|
Default value: | False |
이 도움말 메시지를 표시하고 종료합니다.
경고를 표시하지 않고 오류만 표시합니다.
속성 | 값 |
---|---|
Default value: | False |
Output format.
속성 | 값 |
---|---|
Default value: | json |
허용되는 값: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 쿼리 문자열입니다. 자세한 내용 및 예제는 http://jmespath.org/ 참조하세요.
로깅의 자세한 정도를 증가시킵니다. 전체 디버그 로그에 --debug를 사용합니다.
속성 | 값 |
---|---|
Default value: | False |
az apic api list
API 컬렉션을 나열합니다.
az apic api list --resource-group
--service-name
[--filter]
[--max-items]
[--next-token]
예제
List APIs
az apic api list -g contoso-resources -n contoso
필터를 사용하여 API 나열
az apic api list -g contoso-resources -n contoso --filter "kind eq 'rest'"
필수 매개 변수
리소스 그룹의 이름입니다.
az configure --defaults group=<name>
사용하여 기본 그룹을 구성할 수 있습니다.
Azure API Center 서비스의 이름입니다.
선택적 매개 변수
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
OData 필터 매개 변수입니다.
명령의 출력에서 반환할 총 항목 수입니다. 사용 가능한 총 항목 수가 지정된 값보다 많으면 명령의 출력에 토큰이 제공됩니다. 페이지 매김을 다시 시작하려면 후속 명령의 --next-token
인수에 토큰 값을 제공합니다.
속성 | 값 |
---|---|
Parameter group: | Pagination Arguments |
페이지 매김을 시작할 위치를 지정하는 토큰입니다. 이는 이전에 잘린 응답의 토큰 값입니다.
속성 | 값 |
---|---|
Parameter group: | Pagination Arguments |
전역 매개 변수
로깅 수위를 높여 모든 디버그 로그를 표시합니다.
속성 | 값 |
---|---|
Default value: | False |
이 도움말 메시지를 표시하고 종료합니다.
경고를 표시하지 않고 오류만 표시합니다.
속성 | 값 |
---|---|
Default value: | False |
Output format.
속성 | 값 |
---|---|
Default value: | json |
허용되는 값: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 쿼리 문자열입니다. 자세한 내용 및 예제는 http://jmespath.org/ 참조하세요.
구독의 이름 또는 ID입니다.
az account set -s NAME_OR_ID
사용하여 기본 구독을 구성할 수 있습니다.
로깅의 자세한 정도를 증가시킵니다. 전체 디버그 로그에 --debug를 사용합니다.
속성 | 값 |
---|---|
Default value: | False |
az apic api register
이 명령은 미리 보기로 제공되며 개발 중입니다. 참조 및 지원 수준: https://aka.ms/CLI_refstatus
사양 파일을 진리 원본으로 사용하여 버전, 정의 및 관련 배포에 새 API를 등록합니다. 지금은 OpenAPI JSON/YAML 형식만 지원합니다.
az apic api register --api-location
--resource-group
--service-name
[--environment-id]
예제
사양 파일을 제공하여 API를 등록합니다.
az apic api register -g api-center-test -n contosoeuap --api-location "examples/cli-examples/spec-examples/openai.json" --environment-id public
az apic api register -g api-center-test -n contosoeuap --api-location "examples/cli-examples/spec-examples/openai.yml" --environment-id public
사양 URL을 제공하여 API를 등록합니다.
az apic api register -g api-center-test -n contosoeuap --api-location "https://petstore.swagger.io/v2/swagger.json" --environment-id public
az apic api register -g api-center-test -n contosoeuap --api-location "https://petstore.swagger.io/v2/swagger.yaml" --environment-id public
필수 매개 변수
사양 파일의 위치입니다.
리소스 그룹 이름
APICenter 카탈로그 또는 서비스 이름입니다.
선택적 매개 변수
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
이전에 만든 환경의 ID입니다.
전역 매개 변수
로깅 수위를 높여 모든 디버그 로그를 표시합니다.
속성 | 값 |
---|---|
Default value: | False |
이 도움말 메시지를 표시하고 종료합니다.
경고를 표시하지 않고 오류만 표시합니다.
속성 | 값 |
---|---|
Default value: | False |
Output format.
속성 | 값 |
---|---|
Default value: | json |
허용되는 값: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 쿼리 문자열입니다. 자세한 내용 및 예제는 http://jmespath.org/ 참조하세요.
구독의 이름 또는 ID입니다.
az account set -s NAME_OR_ID
사용하여 기본 구독을 구성할 수 있습니다.
로깅의 자세한 정도를 증가시킵니다. 전체 디버그 로그에 --debug를 사용합니다.
속성 | 값 |
---|---|
Default value: | False |
az apic api show
API의 세부 정보를 가져옵니다.
az apic api show [--api-id]
[--ids]
[--resource-group]
[--service-name]
[--subscription]
예제
API 세부 정보 표시
az apic api show -g contoso-resources -n contoso --api-id echo-api
선택적 매개 변수
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
API의 ID입니다.
속성 | 값 |
---|---|
Parameter group: | Resource Id Arguments |
하나 이상의 리소스 ID(공백으로 구분). '리소스 ID' 인수의 모든 정보를 포함하는 전체 리소스 ID여야 합니다. --ids 또는 다른 '리소스 ID' 인수를 제공해야 합니다.
속성 | 값 |
---|---|
Parameter group: | Resource Id Arguments |
리소스 그룹의 이름입니다.
az configure --defaults group=<name>
사용하여 기본 그룹을 구성할 수 있습니다.
속성 | 값 |
---|---|
Parameter group: | Resource Id Arguments |
Azure API Center 서비스의 이름입니다.
속성 | 값 |
---|---|
Parameter group: | Resource Id Arguments |
구독의 이름 또는 ID입니다.
az account set -s NAME_OR_ID
사용하여 기본 구독을 구성할 수 있습니다.
속성 | 값 |
---|---|
Parameter group: | Resource Id Arguments |
전역 매개 변수
로깅 수위를 높여 모든 디버그 로그를 표시합니다.
속성 | 값 |
---|---|
Default value: | False |
이 도움말 메시지를 표시하고 종료합니다.
경고를 표시하지 않고 오류만 표시합니다.
속성 | 값 |
---|---|
Default value: | False |
Output format.
속성 | 값 |
---|---|
Default value: | json |
허용되는 값: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 쿼리 문자열입니다. 자세한 내용 및 예제는 http://jmespath.org/ 참조하세요.
로깅의 자세한 정도를 증가시킵니다. 전체 디버그 로그에 --debug를 사용합니다.
속성 | 값 |
---|---|
Default value: | False |
az apic api update
기존 API를 업데이트합니다.
az apic api update [--add]
[--api-id]
[--contacts]
[--custom-properties]
[--description]
[--external-documentation]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--license]
[--remove]
[--resource-group]
[--service-name]
[--set]
[--subscription]
[--summary]
[--title]
[--type {graphql, grpc, rest, soap, webhook, websocket}]
예제
Update API
az apic api update -g contoso-resources -n contoso --api-id echo-api --summary "Basic REST API service"
사용자 지정 속성 업데이트
az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '{"public-facing":true}'
json 파일을 사용하여 사용자 지정 속성 업데이트
az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '@customProperities.json'
단일 사용자 지정 메타데이터 업데이트
az apic api update -g contoso-resources -n contoso --api-id echo-api --set customProperties.internal=false
선택적 매개 변수
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
경로 및 키 값 쌍을 지정하여 개체 목록에 개체를 추가합니다. 예: --add property.listProperty <key=value, string or JSON string>
.
속성 | 값 |
---|---|
Parameter group: | Generic Update Arguments |
API의 ID입니다.
속성 | 값 |
---|---|
Parameter group: | Resource Id Arguments |
API에 대한 연락처 정보입니다. 약식 구문, json-file 및 yaml-file을 지원합니다. 더 많은 것을 표시하려면 "??"를 시도해 보세요.
속성 | 값 |
---|---|
Parameter group: | Properties Arguments |
API 카탈로그 엔터티에 대해 정의된 사용자 지정 메타데이터입니다. 약식 구문, json-file 및 yaml-file을 지원합니다. 더 많은 것을 표시하려면 "??"를 시도해 보세요.
속성 | 값 |
---|---|
Parameter group: | Properties Arguments |
API에 대한 설명입니다.
속성 | 값 |
---|---|
Parameter group: | Properties Arguments |
API에 대한 추가 외부 설명서입니다. 약식 구문, json-file 및 yaml-file을 지원합니다. 더 많은 것을 표시하려면 "??"를 시도해 보세요.
속성 | 값 |
---|---|
Parameter group: | Properties Arguments |
'set' 또는 'add'를 사용하는 경우 JSON으로 변환하는 대신 문자열 리터럴을 유지합니다.
속성 | 값 |
---|---|
Parameter group: | Generic Update Arguments |
허용되는 값: | 0, 1, f, false, n, no, t, true, y, yes |
하나 이상의 리소스 ID(공백으로 구분). '리소스 ID' 인수의 모든 정보를 포함하는 전체 리소스 ID여야 합니다. --ids 또는 다른 '리소스 ID' 인수를 제공해야 합니다.
속성 | 값 |
---|---|
Parameter group: | Resource Id Arguments |
API에 대한 라이선스 정보입니다. 약식 구문, json-file 및 yaml-file을 지원합니다. 더 많은 것을 표시하려면 "??"를 시도해 보세요.
속성 | 값 |
---|---|
Parameter group: | Properties Arguments |
목록에서 속성 또는 요소를 제거합니다. 예: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
속성 | 값 |
---|---|
Parameter group: | Generic Update Arguments |
리소스 그룹의 이름입니다.
az configure --defaults group=<name>
사용하여 기본 그룹을 구성할 수 있습니다.
속성 | 값 |
---|---|
Parameter group: | Resource Id Arguments |
Azure API Center 서비스의 이름입니다.
속성 | 값 |
---|---|
Parameter group: | Resource Id Arguments |
설정할 속성 경로와 값을 지정하여 개체를 업데이트합니다. 예: --set property1.property2=<value>
.
속성 | 값 |
---|---|
Parameter group: | Generic Update Arguments |
구독의 이름 또는 ID입니다.
az account set -s NAME_OR_ID
사용하여 기본 구독을 구성할 수 있습니다.
속성 | 값 |
---|---|
Parameter group: | Resource Id Arguments |
API에 대한 간단한 설명입니다.
속성 | 값 |
---|---|
Parameter group: | Properties Arguments |
API title.
속성 | 값 |
---|---|
Parameter group: | Properties Arguments |
API의 유형입니다.
속성 | 값 |
---|---|
Parameter group: | Properties Arguments |
허용되는 값: | graphql, grpc, rest, soap, webhook, websocket |
전역 매개 변수
로깅 수위를 높여 모든 디버그 로그를 표시합니다.
속성 | 값 |
---|---|
Default value: | False |
이 도움말 메시지를 표시하고 종료합니다.
경고를 표시하지 않고 오류만 표시합니다.
속성 | 값 |
---|---|
Default value: | False |
Output format.
속성 | 값 |
---|---|
Default value: | json |
허용되는 값: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 쿼리 문자열입니다. 자세한 내용 및 예제는 http://jmespath.org/ 참조하세요.
로깅의 자세한 정도를 증가시킵니다. 전체 디버그 로그에 --debug를 사용합니다.
속성 | 값 |
---|---|
Default value: | False |