다음을 통해 공유

az apim api

  • 참조

Azure API Management API를 관리합니다.

명령

Name Description 형식 상태
az apim api create

API Management API를 만듭니다.

 핵심 GA
az apim api delete

API Management API를 삭제합니다.

 핵심 GA
az apim api export

API Management API를 내보냅니다.

 핵심 GA
az apim api import

API Management API를 가져옵니다.

 핵심 GA
az apim api list

API Management API를 나열합니다.

 핵심 GA
az apim api operation

Azure API Management API 작업을 관리합니다.

 핵심 GA
az apim api operation create

API에서 새 작업을 만듭니다.

 핵심 GA
az apim api operation delete

API에서 지정된 작업을 삭제합니다.

 핵심 GA
az apim api operation list

지정된 API에 대한 작업의 컬렉션을 나열합니다.

 핵심 GA
az apim api operation show

식별자가 지정한 API 작업의 세부 정보를 가져옵니다.

 핵심 GA
az apim api operation update

식별자가 지정한 API에서 작업의 세부 정보를 업데이트.

 핵심 GA
az apim api release

Azure API Management API 릴리스를 관리합니다.

 핵심 GA
az apim api release create

API에 대한 새 릴리스를 만듭니다.

 핵심 GA
az apim api release delete

API에서 지정된 릴리스를 삭제합니다.

 핵심 GA
az apim api release list

API의 모든 릴리스를 나열합니다.

 핵심 GA
az apim api release show

API 릴리스의 세부 정보를 반환합니다.

 핵심 GA
az apim api release update

식별자가 지정한 API 릴리스의 세부 정보를 업데이트.

 핵심 GA
az apim api revision

Azure API Management API 수정 버전을 관리합니다.

 핵심 GA
az apim api revision create

API 수정 버전을 만듭니다.

 핵심 GA
az apim api revision list

API의 모든 수정 버전을 나열합니다.

 핵심 GA
az apim api schema

Azure API Management API 스키마를 관리합니다.

 핵심 GA
az apim api schema create

API Management API 스키마를 만듭니다.

 핵심 GA
az apim api schema delete

API Management API 스키마를 삭제합니다.

 핵심 GA
az apim api schema get-etag

API Management API 스키마의 etag를 가져옵니다.

 핵심 GA
az apim api schema list

API Management API 스키마를 나열합니다.

 핵심 GA
az apim api schema show

API Management API 스키마의 세부 정보를 표시합니다.

 핵심 GA
az apim api schema wait

apim api 스키마의 조건이 충족될 때까지 CLI를 대기 상태로 설정합니다.

 핵심 GA
az apim api show

API Management API의 세부 정보를 표시합니다.

 핵심 GA
az apim api update

API Management API를 업데이트합니다.

 핵심 GA
az apim api versionset

Azure API Management API 버전 집합을 관리합니다.

 핵심 GA
az apim api versionset create

API 버전 집합을 만듭니다.

 핵심 GA
az apim api versionset delete

특정 API 버전 집합을 삭제합니다.

 핵심 GA
az apim api versionset list

지정된 서비스 인스턴스의 API 버전 집합 컬렉션을 나열합니다.

 핵심 GA
az apim api versionset show

식별자가 지정한 Api 버전 집합의 세부 정보를 가져옵니다.

 핵심 GA
az apim api versionset update

식별자가 지정한 Api VersionSet의 세부 정보를 업데이트.

 핵심 GA
az apim api wait

apim API의 조건이 충족될 때까지 CLI를 대기 상태로 설정합니다.

 핵심 GA

az apim api create

편집

API Management API를 만듭니다.

az apim api create --api-id
                   --display-name
                   --path
                   --resource-group
                   --service-name
                   [--api-type {graphql, http, soap, websocket}]
                   [--authorization-scope]
                   [--authorization-server-id]
                   [--bearer-token-sending-methods]
                   [--description]
                   [--no-wait]
                   [--open-id-provider-id]
                   [--protocols {http, https, ws, wss}]
                   [--service-url]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-key-required]
                   [--subscription-required {false, true}]

예제

기본 API를 만듭니다.

az apim api create --service-name MyApim -g MyResourceGroup --api-id MyApi --path '/myapi' --display-name 'My API'

필수 매개 변수

--api-id

만들 API의 고유 이름입니다.

API 수정 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 다음이 있습니다. rev=n은 접미사로, n은 수정 번호입니다.

--display-name

만들 API의 표시 이름입니다.

--path

API에 대한 경로입니다.

--resource-group -g

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

--service-name -n

API Management 서비스 인스턴스의 이름입니다.

선택적 매개 변수

--api-type

API의 형식입니다.

허용되는 값: graphql, http, soap, websocket
--authorization-scope

OAuth 작업 범위를 지정합니다.

--authorization-server-id

OAuth 권한 부여 서버 ID를 지정합니다.

--bearer-token-sending-methods

전달자 토큰에 대한 전송 메서드를 지정합니다.

--description

API에 대한 설명입니다. HTML 서식 지정 태그를 포함할 수 있습니다.

--no-wait

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

Default value: False
--open-id-provider-id

인증 설정에서 openid를 지정합니다.

--protocols

이 API의 작업을 호출할 수 있는 프로토콜을 설명합니다.

허용되는 값: http, https, ws, wss
--service-url

이 API를 구현하는 백 엔드 서비스의 절대 URL입니다. 2000자를 초과할 수 없습니다.

--subscription-key-header-name

구독 키 헤더 이름을 지정합니다.

--subscription-key-query-param-name

구독 키 쿼리 문자열 매개 변수 이름을 지정합니다.

--subscription-key-required

이 API를 호출하는 동안 구독 키가 필요한지 여부를 지정합니다. true - API는 닫힌 제품에만 포함되고, false - API는 오픈 제품에만 포함됩니다. null - 제품이 혼합되어 있습니다.

--subscription-required

true이면 API에 요청에 대한 구독 키가 필요합니다.

허용되는 값: false, true
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 apim api delete

편집

API Management API를 삭제합니다.

az apim api delete --api-id
                   --resource-group
                   --service-name
                   [--delete-revisions]
                   [--if-match]
                   [--no-wait]
                   [--yes]

필수 매개 변수

--api-id

API 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 다음이 있습니다. rev=n은 접미사로, n은 수정 번호입니다.

--resource-group -g

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

--service-name -n

API Management 서비스 인스턴스의 이름입니다.

선택적 매개 변수

--delete-revisions

API의 모든 수정 버전을 삭제합니다.

--if-match

엔터티의 ETag입니다.

--no-wait

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

Default value: False
--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 apim api export

편집

API Management API를 내보냅니다.

az apim api export --api-id
                   --ef {OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl}
                   --resource-group
                   --service-name
                   [--file-path]

예제

API Management API를 파일로 내보내거나 내보내기 링크가 포함된 응답을 반환합니다.

az apim api export -g MyResourceGroup --service-name MyApim --api-id MyApi --export-format OpenApiJson --file-path path

필수 매개 변수

--api-id

API 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 다음이 있습니다. rev=n은 접미사로, n은 수정 번호입니다. 정규식 패턴: ^[^*#&+:<>?] +$.

--ef --export-format

내보내는 API의 형식을 지정합니다.

허용되는 값: OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl
--resource-group -g

리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.

--service-name -n

API Management 서비스 인스턴스의 이름입니다.

선택적 매개 변수

--file-path -f

API를 내보내도록 지정된 파일 경로입니다.

전역 매개 변수
--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 apim api import

편집

API Management API를 가져옵니다.

az apim api import --path
                   --resource-group
                   --service-name
                   --specification-format {GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl}
                   [--api-id]
                   [--api-revision]
                   [--api-type {graphql, http, soap, websocket}]
                   [--api-version]
                   [--api-version-set-id]
                   [--description]
                   [--display-name]
                   [--no-wait]
                   [--protocols {http, https, ws, wss}]
                   [--service-url]
                   [--soap-api-type]
                   [--specification-path]
                   [--specification-url]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-required {false, true}]
                   [--wsdl-endpoint-name]
                   [--wsdl-service-name]

예제

파일 또는 URL에서 API Management API 가져오기

az apim api import -g MyResourceGroup --service-name MyApim --path MyApi --specification-url https://MySpecificationURL --specification-format OpenApiJson

필수 매개 변수

--path

필수입니다. API Management 서비스 인스턴스 내의 이 API 및 모든 해당 리소스 경로를 고유하게 식별하는 상대 URL입니다.

--resource-group -g

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

--service-name -n

API Management 서비스 인스턴스의 이름입니다.

--specification-format

가져온 API의 형식을 지정합니다.

허용되는 값: GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl

선택적 매개 변수

--api-id

API 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 다음이 있습니다. rev=n은 접미사로, n은 수정 번호입니다.

--api-revision

API의 수정 버전을 설명합니다. 값이 제공되지 않으면 기본 수정 버전 1이 만들어집니다.

--api-type

API의 형식입니다.

허용되는 값: graphql, http, soap, websocket
--api-version

API의 버전을 설명합니다. 버전이 아닌 API에 버전을 추가하는 경우 원래 버전이 자동으로 만들어지고 기본 URL에 응답합니다.

--api-version-set-id

API와 함께 사용할 버전 집합에 대해 설명합니다.

--description

API에 대한 설명입니다. HTML 서식 지정 태그를 포함할 수 있습니다.

--display-name

이 API의 표시 이름입니다.

--no-wait

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

Default value: False
--protocols

이 API에서 작업을 호출할 수 있는 프로토콜(하나 이상)에 대해 설명합니다.

허용되는 값: http, https, ws, wss
--service-url

이 API를 구현하는 백 엔드 서비스의 절대 URL입니다. 2000자를 초과할 수 없습니다.

--soap-api-type

파일 형식이 WSDL인 경우 API의 형식입니다.

--specification-path

API를 가져오기 위해 지정된 파일 경로입니다.

--specification-url

API를 가져오기 위해 지정된 URL입니다.

--subscription-key-header-name

구독 키 헤더 이름을 지정합니다.

--subscription-key-query-param-name

구독 키 쿼리 문자열 매개 변수 이름을 지정합니다.

--subscription-required

true이면 API에 요청에 대한 구독 키가 필요합니다.

허용되는 값: false, true
--wsdl-endpoint-name

가져올 WSDL 엔드포인트(포트)의 로컬 이름입니다.

--wsdl-service-name

가져올 WSDL 서비스의 로컬 이름입니다.

전역 매개 변수
--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 apim api list

편집

API Management API를 나열합니다.

az apim api list --resource-group
                 --service-name
                 [--filter-display-name]
                 [--skip]
                 [--top]

필수 매개 변수

--resource-group -g

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

--service-name -n

API Management 서비스 인스턴스의 이름입니다.

선택적 매개 변수

--filter-display-name

displayName별 API 필터입니다.

--skip

건너뛸 레코드 수입니다.

--top

반환할 레코드의 수입니다.

전역 매개 변수
--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 apim api show

편집

API Management API의 세부 정보를 표시합니다.

az apim api show --api-id
                 --resource-group
                 --service-name

필수 매개 변수

--api-id

API 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 다음이 있습니다. rev=n은 접미사로, n은 수정 번호입니다.

--resource-group -g

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

--service-name

API Management 서비스 인스턴스의 이름입니다.

전역 매개 변수
--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 apim api update

편집

API Management API를 업데이트합니다.

az apim api update --api-id
                   --resource-group
                   --service-name
                   [--add]
                   [--api-type {graphql, http, soap, websocket}]
                   [--description]
                   [--display-name]
                   [--force-string]
                   [--if-match]
                   [--no-wait]
                   [--path]
                   [--protocols {http, https, ws, wss}]
                   [--remove]
                   [--service-url]
                   [--set]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-required {false, true}]
                   [--tags]

예제

기본 API를 만듭니다.

az apim api update --service-name MyApim -g MyResourceGroup --api-id MyApi --description foo

필수 매개 변수

--api-id

만들 API의 고유 이름입니다.

API 수정 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 다음이 있습니다. rev=n은 접미사로, n은 수정 번호입니다.

--resource-group -g

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

--service-name -n

API Management 서비스 인스턴스의 이름입니다.

선택적 매개 변수

--add

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

Default value: []
--api-type

API의 형식입니다.

허용되는 값: graphql, http, soap, websocket
--description

API에 대한 설명입니다. HTML 서식 지정 태그를 포함할 수 있습니다.

--display-name

API 이름입니다. 길이는 1~300자여야 합니다.

--force-string

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

Default value: False
--if-match

엔터티의 ETag입니다. 엔터티를 만들 때는 필요하지 않지만 엔터티를 업데이트할 때 필요합니다. 기본값은 None입니다.

--no-wait

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

Default value: False
--path

필수입니다. API Management 서비스 인스턴스 내의 이 API 및 모든 해당 리소스 경로를 고유하게 식별하는 상대 URL입니다.

--protocols

이 API의 작업을 호출할 수 있는 프로토콜을 설명합니다.

허용되는 값: http, https, ws, wss
--remove

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

Default value: []
--service-url

이 API를 구현하는 백 엔드 서비스의 절대 URL입니다. 2000자를 초과할 수 없습니다.

--set

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

Default value: []
--subscription-key-header-name

구독 키 헤더 이름을 지정합니다.

--subscription-key-query-param-name

구독 키 쿼리 문자열 매개 변수 이름을 지정합니다.

--subscription-required

true이면 API에 요청에 대한 구독 키가 필요합니다.

허용되는 값: false, true
--tags

공백으로 구분된 태그: key[=value] [key[=value] ...]. ""를 사용하여 기존 태그를 지웁니다.

전역 매개 변수
--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 apim api wait

편집

apim API의 조건이 충족될 때까지 CLI를 대기 상태로 설정합니다.

az apim api wait --api-id
                 --name
                 --resource-group
                 [--created]
                 [--custom]
                 [--deleted]
                 [--exists]
                 [--interval]
                 [--timeout]
                 [--updated]

예제

apim API의 조건이 충족될 때까지 CLI를 대기 상태로 설정합니다. (자동 생성됨)

az apim api wait --created --api-id MyApi --name MyApim --resource-group MyResourceGroup

필수 매개 변수

--api-id

API 수정 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 다음이 있습니다. rev=n은 접미사로, n은 수정 번호입니다. 필수입니다.

--name -n

API Management 서비스 인스턴스의 이름입니다.

--resource-group -g

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

선택적 매개 변수

--created

'Succeeded'에서 'provisioningState'를 사용하여 생성될 때까지 기다립니다.

Default value: False
--custom

조건이 사용자 지정 JMESPath 쿼리를 충족할 때까지 기다립니다. 예: provisioningState!='InProgress', instanceView. 상태es[?code=='PowerState/running'].

--deleted

삭제될 때까지 기다립니다.

Default value: False
--exists

리소스가 존재할 때까지 기다립니다.

Default value: False
--interval

폴링 간격(초)입니다.

Default value: 30
--timeout

최대 대기 시간(초)입니다.

Default value: 3600
--updated

'Succeeded'에서 provisioningState로 업데이트될 때까지 기다립니다.

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를 사용합니다.