az apic metadata

참조

참고 항목

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

API 센터에서 메타데이터 스키마를 관리하는 명령입니다.

명령

Name	Description	형식	상태
az apic metadata create	새 메타데이터 스키마를 만들거나 기존 메타데이터 스키마를 업데이트합니다.	내선 번호	GA
az apic metadata delete	지정된 메타데이터 스키마를 삭제합니다.	내선 번호	GA
az apic metadata export	메타데이터 스키마를 내보냅니다.	내선 번호	GA
az apic metadata list	메타데이터 스키마 컬렉션을 나열합니다.	내선 번호	GA
az apic metadata show	메타데이터 스키마의 세부 정보를 가져옵니다.	내선 번호	GA
az apic metadata update	기존 메타데이터 스키마를 업데이트합니다.	내선 번호	GA

az apic metadata create

새 메타데이터 스키마를 만들거나 기존 메타데이터 스키마를 업데이트합니다.

az apic metadata create --assignments
                        --metadata-name
                        --resource-group
                        --schema
                        --service-name

예제

메타데이터 만들기 예제 1

az apic metadata create --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '{"type":"string", "title":"First name", "pattern": "^[a-zA-Z0-9]+$"}' --assignments '[{entity:api,required:true,deprecated:false}]'

메타데이터 만들기 예제 2

az apic metadata create --resource-group api-center-test --service-name contoso  --metadata-name testregion --schema '{"type":"string","title":"testregion","oneOf":[{"const":"Region1","description":""},{"const":"Region2","description":""},{"const":"Region3","description":""}]}' --assignments '[{entity:api,required:true,deprecated:false},{entity:environment,required:true,deprecated:false}]'

필수 매개 변수

--assignments

사용자 지정 메타데이터의 할당 범위(예: "[{entity:api,required:true,deprecated:false}]])"를 정의합니다. 사용 가능한 엔터티 값은 api, 배포, 환경입니다. 약식 구문, json-file 및 yaml-file을 지원합니다. 더 많은 것을 표시하려면 "??"를 시도해 보세요.

--metadata-name

메타데이터 스키마의 이름입니다.

--resource-group -g

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

--schema

형식을 정의하는 JSON 스키마입니다.

--service-name -n

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

전역 매개 변수

--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 apic metadata delete

지정된 메타데이터 스키마를 삭제합니다.

az apic metadata delete [--ids]
                        [--metadata-name]
                        [--resource-group]
                        [--service-name]
                        [--subscription]
                        [--yes]

예제

메타데이터 스키마 삭제

az apic metadata delete --resource-group api-center-test --service-name contoso --metadata-name "test1"

스키마 삭제

az apic metadata delete -g api-center-test -n contosoeuap --metadata-name "approver"

선택적 매개 변수

--ids

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

--metadata-name

메타데이터 스키마의 이름입니다.

--resource-group -g

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

--service-name -n

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

--subscription

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

--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 apic metadata export

메타데이터 스키마를 내보냅니다.

az apic metadata export --assignments {api, deployment, environment}
                        --file-name
                        [--ids]
                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                        [--resource-group]
                        [--service-name]
                        [--subscription]

예제

API에 할당된 메타데이터 스키마 내보내기

az apic metadata export -g api-center-test -n contosoeuap --assignments api --file-name filename.json

배포에 할당된 메타데이터 스키마 내보내기

az apic metadata export -g api-center-test -n contosoeuap --assignments deployment --file-name filename.json

환경에 할당된 메타데이터 스키마 내보내기

az apic metadata export -g api-center-test -n contosoeuap --assignments environment --file-name filename.json

필수 매개 변수

--assignments

메타데이터 스키마가 요청되는 엔터티입니다.

허용되는 값: api, deployment, environment

--file-name

메타데이터 스키마를 내보낼 파일의 이름입니다.

선택적 매개 변수

--ids

--no-wait

장기 실행 작업이 완료되기를 기다리지 마세요.

허용되는 값: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

--service-name -n

API 센터 서비스의 이름입니다.

--subscription

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

전역 매개 변수

--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 apic metadata list

메타데이터 스키마 컬렉션을 나열합니다.

az apic metadata list --resource-group
                      --service-name
                      [--filter]
                      [--max-items]
                      [--next-token]

예제

스키마 나열

az apic metadata list -g api-center-test -n contosoeuap

필수 매개 변수

--resource-group -g

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

--service-name -n

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

선택적 매개 변수

--filter

OData 필터 매개 변수입니다.

--max-items

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

--next-token

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

전역 매개 변수

--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 apic metadata show

메타데이터 스키마의 세부 정보를 가져옵니다.

az apic metadata show [--ids]
                      [--metadata-name]
                      [--resource-group]
                      [--service-name]
                      [--subscription]

예제

스키마 세부 정보 표시 1

az apic metadata show -g api-center-test -n contosoeuap --metadata-name approver

스키마 세부 정보 표시 2

az apic metadata show --resource-group api-center-test --service-name contoso --metadata-name "testchoices"

선택적 매개 변수

--ids

--metadata-name

메타데이터 스키마의 이름입니다.

--resource-group -g

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

--service-name -n

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

--subscription

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

전역 매개 변수

--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 apic metadata update

기존 메타데이터 스키마를 업데이트합니다.

az apic metadata update [--add]
                        [--assignments]
                        [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                        [--ids]
                        [--metadata-name]
                        [--remove]
                        [--resource-group]
                        [--schema]
                        [--service-name]
                        [--set]
                        [--subscription]

예제

스키마 업데이트

az apic metadata update --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '{"type":"string", "title":"Last name", "pattern": "^[a-zA-Z0-9]+$"}'

선택적 매개 변수

--add

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

--assignments

--force-string

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

허용되는 값: 0, 1, f, false, n, no, t, true, y, yes

--ids

--metadata-name

메타데이터 스키마의 이름입니다.

--remove

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

--resource-group -g

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

--schema

형식을 정의하는 YAML 스키마입니다.

--service-name -n

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

--set

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

--subscription

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

전역 매개 변수

--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 apic metadata

명령

az apic metadata create

예제

필수 매개 변수

az apic metadata delete

예제

선택적 매개 변수

az apic metadata export

예제

필수 매개 변수

선택적 매개 변수

az apic metadata list

예제

필수 매개 변수

선택적 매개 변수

az apic metadata show

예제

선택적 매개 변수

az apic metadata update

예제

선택적 매개 변수

추가 리소스