az apic api deployment

Note

이 참조는 Azure CLI(버전 2.57.0 이상)에 대한 apic 확장 확장의 일부입니다. az apic api deployment 명령을 처음 실행할 때 확장이 자동으로 설치됩니다. 확장 프로그램에 대해 자세히 알아보세요.

API 센터에서 API 배포를 관리하는 명령입니다.

명령

Name	Description	형식	상태
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 deployment create

새 API 배포를 만들거나 기존 API 배포를 업데이트합니다.

az apic api deployment create --api-id
                              --definition-id
                              --deployment-id
                              --environment-id
                              --resource-group
                              --server
                              --service-name
                              --title
                              [--custom-properties]
                              [--description]

예제

배포 생성하기

az apic api deployment create -g api-center-test -n contoso --deployment-id production --title "Production deployment" --description "Public cloud production deployment." --api-id echo-api --environment-id "/workspaces/default/environments/production" --definition-id "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi" --server '{"runtimeUri":["https://example.com"]}'

서버 json 파일을 사용하여 배포 만들기

az apic api deployment create -g api-center-test -n contoso --deployment-id production --title "Production deployment" --description "Public cloud production deployment." --api-id echo-api --environment-id "/workspaces/default/environments/production" --definition-id "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi" --server '@server.json'

필수 매개 변수

--api-id

API의 ID입니다.

--definition-id

API 센터 범위 정의 리소스 ID입니다.

속성	값
매개 변수 그룹:	Properties Arguments

--deployment-id

API 배포의 ID입니다.

--environment-id

API 센터 범위 환경 리소스 ID입니다.

속성	값
매개 변수 그룹:	Properties Arguments

--resource-group -g

리소스 그룹의 이름입니다. az configure --defaults group=<name>사용하여 기본 그룹을 구성할 수 있습니다.

--server

서버 지원 약식 구문, json-file 및 yaml-file. 더 많은 것을 표시하려면 "??"를 시도해 보세요.

속성	값
매개 변수 그룹:	Properties Arguments

--service-name -n

Azure API Center 서비스의 이름입니다.

--title

배포 제목입니다.

속성	값
매개 변수 그룹:	Properties Arguments

선택적 매개 변수

다음 매개 변수는 선택 사항이지만 컨텍스트에 따라 명령이 성공적으로 실행되려면 하나 이상의 매개 변수가 필요할 수 있습니다.

--custom-properties

API 카탈로그 엔터티에 대해 정의된 사용자 지정 메타데이터입니다. 약식 구문, json-file 및 yaml-file을 지원합니다. 더 많은 것을 표시하려면 "??"를 시도해 보세요.

속성	값
매개 변수 그룹:	Properties Arguments

--description

배포에 대한 설명입니다.

속성	값
매개 변수 그룹:	Properties 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

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

--verbose

로깅의 자세한 정도를 증가시킵니다. 전체 디버그 로그에 --debug를 사용합니다.

속성	값
Default value:	False

az apic api deployment delete

API 배포를 삭제합니다.

az apic api deployment delete [--api-id]
                              [--deployment-id]
                              [--ids]
                              [--resource-group]
                              [--service-name]
                              [--subscription]
                              [--yes]

예제

API 배포 삭제

az apic api deployment delete -g api-center-test -n contoso --deployment-id production --api-id echo-api

선택적 매개 변수

다음 매개 변수는 선택 사항이지만 컨텍스트에 따라 명령이 성공적으로 실행되려면 하나 이상의 매개 변수가 필요할 수 있습니다.

--api-id

API의 ID입니다.

속성	값
매개 변수 그룹:	Resource Id Arguments

--deployment-id

API 배포의 ID입니다.

속성	값
매개 변수 그룹:	Resource Id Arguments

--ids

하나 이상의 리소스 ID(공백으로 구분). '리소스 ID' 인수의 모든 정보를 포함하는 전체 리소스 ID여야 합니다. --ids 또는 다른 '리소스 ID' 인수를 제공해야 합니다.

속성	값
매개 변수 그룹:	Resource Id Arguments

--resource-group -g

리소스 그룹의 이름입니다. az configure --defaults group=<name>사용하여 기본 그룹을 구성할 수 있습니다.

속성	값
매개 변수 그룹:	Resource Id Arguments

--service-name -n

Azure API Center 서비스의 이름입니다.

속성	값
매개 변수 그룹:	Resource Id Arguments

--subscription

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

속성	값
매개 변수 그룹:	Resource Id Arguments

--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/ 참조하세요.

--verbose

로깅의 자세한 정도를 증가시킵니다. 전체 디버그 로그에 --debug를 사용합니다.

속성	값
Default value:	False

az apic api deployment list

API 배포의 컬렉션을 나열합니다.

az apic api deployment list --api-id
                            --resource-group
                            --service-name
                            [--filter]
                            [--max-items]
                            [--next-token]

예제

API 배포 나열

az apic api deployment list -g api-center-test -n contoso --api-id echo-api

필수 매개 변수

--api-id

API의 ID입니다.

--resource-group -g

리소스 그룹의 이름입니다. az configure --defaults group=<name>사용하여 기본 그룹을 구성할 수 있습니다.

--service-name -n

Azure API Center 서비스의 이름입니다.

선택적 매개 변수

다음 매개 변수는 선택 사항이지만 컨텍스트에 따라 명령이 성공적으로 실행되려면 하나 이상의 매개 변수가 필요할 수 있습니다.

--filter

OData 필터 매개 변수입니다.

--max-items

명령의 출력에서 반환할 총 항목 수입니다. 사용 가능한 총 항목 수가 지정된 값보다 많으면 명령의 출력에 토큰이 제공됩니다. 페이지 매김을 다시 시작하려면 후속 명령의 --next-token 인수에 토큰 값을 제공합니다.

속성	값
매개 변수 그룹:	Pagination Arguments

--next-token

페이지 매김을 시작할 위치를 지정하는 토큰입니다. 이는 이전에 잘린 응답의 토큰 값입니다.

속성	값
매개 변수 그룹:	Pagination 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

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

--verbose

로깅의 자세한 정도를 증가시킵니다. 전체 디버그 로그에 --debug를 사용합니다.

속성	값
Default value:	False

az apic api deployment show

API 배포에 대한 세부 정보를 가져옵니다.

az apic api deployment show [--api-id]
                            [--deployment-id]
                            [--ids]
                            [--resource-group]
                            [--service-name]
                            [--subscription]

예제

API 배포 세부 정보 표시

az apic api deployment show -g api-center-test -n contoso --deployment-id production --api-id echo-api

선택적 매개 변수

다음 매개 변수는 선택 사항이지만 컨텍스트에 따라 명령이 성공적으로 실행되려면 하나 이상의 매개 변수가 필요할 수 있습니다.

--api-id

API의 ID입니다.

속성	값
매개 변수 그룹:	Resource Id Arguments

--deployment-id

API 배포의 ID입니다.

속성	값
매개 변수 그룹:	Resource Id Arguments

--ids

하나 이상의 리소스 ID(공백으로 구분). '리소스 ID' 인수의 모든 정보를 포함하는 전체 리소스 ID여야 합니다. --ids 또는 다른 '리소스 ID' 인수를 제공해야 합니다.

속성	값
매개 변수 그룹:	Resource Id Arguments

--resource-group -g

리소스 그룹의 이름입니다. az configure --defaults group=<name>사용하여 기본 그룹을 구성할 수 있습니다.

속성	값
매개 변수 그룹:	Resource Id Arguments

--service-name -n

Azure API Center 서비스의 이름입니다.

속성	값
매개 변수 그룹:	Resource Id Arguments

--subscription

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

속성	값
매개 변수 그룹:	Resource Id 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/ 참조하세요.

--verbose

로깅의 자세한 정도를 증가시킵니다. 전체 디버그 로그에 --debug를 사용합니다.

속성	값
Default value:	False

az apic api deployment update

기존 API 배포를 업데이트합니다.

az apic api deployment update [--add]
                              [--api-id]
                              [--custom-properties]
                              [--definition-id]
                              [--deployment-id]
                              [--description]
                              [--environment-id]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--ids]
                              [--remove]
                              [--resource-group]
                              [--server]
                              [--service-name]
                              [--set]
                              [--subscription]
                              [--title]

예제

API 배포 업데이트

az apic api deployment update -g api-center-test -n contoso --deployment-id production --title "Production deployment" --api-id echo-api

선택적 매개 변수

다음 매개 변수는 선택 사항이지만 컨텍스트에 따라 명령이 성공적으로 실행되려면 하나 이상의 매개 변수가 필요할 수 있습니다.

--add

경로 및 키 값 쌍을 지정하여 개체 목록에 개체를 추가합니다. 예: --add property.listProperty <key=value, string or JSON string>.

속성	값
매개 변수 그룹:	Generic Update Arguments

--api-id

API의 ID입니다.

속성	값
매개 변수 그룹:	Resource Id Arguments

--custom-properties

API 카탈로그 엔터티에 대해 정의된 사용자 지정 메타데이터입니다. 약식 구문, json-file 및 yaml-file을 지원합니다. 더 많은 것을 표시하려면 "??"를 시도해 보세요.

속성	값
매개 변수 그룹:	Properties Arguments

--definition-id

서비스 범위 정의 리소스 ID입니다.

속성	값
매개 변수 그룹:	Properties Arguments

--deployment-id

API 배포의 ID입니다.

속성	값
매개 변수 그룹:	Resource Id Arguments

--description

배포에 대한 설명입니다.

속성	값
매개 변수 그룹:	Properties Arguments

--environment-id

서비스 범위 환경 리소스 ID입니다.

속성	값
매개 변수 그룹:	Properties Arguments

--force-string

'set' 또는 'add'를 사용하는 경우 JSON으로 변환하는 대신 문자열 리터럴을 유지합니다.

속성	값
매개 변수 그룹:	Generic Update Arguments
허용되는 값:	0, 1, f, false, n, no, t, true, y, yes

--ids

하나 이상의 리소스 ID(공백으로 구분). '리소스 ID' 인수의 모든 정보를 포함하는 전체 리소스 ID여야 합니다. --ids 또는 다른 '리소스 ID' 인수를 제공해야 합니다.

속성	값
매개 변수 그룹:	Resource Id Arguments

--remove

목록에서 속성 또는 요소를 제거합니다. 예: --remove property.list <indexToRemove> OR --remove propertyToRemove.

속성	값
매개 변수 그룹:	Generic Update Arguments

--resource-group -g

리소스 그룹의 이름입니다. az configure --defaults group=<name>사용하여 기본 그룹을 구성할 수 있습니다.

속성	값
매개 변수 그룹:	Resource Id Arguments

--server

서버 지원 약식 구문, json-file 및 yaml-file. 더 많은 것을 표시하려면 "??"를 시도해 보세요.

속성	값
매개 변수 그룹:	Properties Arguments

--service-name -n

Azure API Center 서비스의 이름입니다.

속성	값
매개 변수 그룹:	Resource Id Arguments

--set

설정할 속성 경로와 값을 지정하여 개체를 업데이트합니다. 예: --set property1.property2=<value>.

속성	값
매개 변수 그룹:	Generic Update Arguments

--subscription

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

속성	값
매개 변수 그룹:	Resource Id Arguments

--title

Title.

속성	값
매개 변수 그룹:	Properties 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/ 참조하세요.

--verbose

로깅의 자세한 정도를 증가시킵니다. 전체 디버그 로그에 --debug를 사용합니다.

속성	값
Default value:	False