다음을 통해 공유

az apim api operation

  • 참조

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

명령

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

편집

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

az apim api operation create --api-id
                             --display-name
                             --method
                             --resource-group
                             --service-name
                             --url-template
                             [--description]
                             [--if-match]
                             [--operation-id]
                             [--params]

예제

여러 매개 변수를 사용하여 API에 새 작업을 만듭니다.

az apim api operation create --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --url-template "/session/{param1}/{param2}" --method "GET" --display-name MyOperationName --description MyDescription --template-parameters name=param1 description=descriptionContent type=paramType required="true" --template-parameters name=param2 required="false" type="string"

필수 매개 변수

--api-id

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

--display-name

필수입니다. 작업 이름입니다.

--method

필수입니다. 유효한 HTTP 작업 메서드입니다. GET, PUT, POST와 같은 일반적인 Http 메서드이지만 이러한 메서드로만 제한되지는 않습니다.

--resource-group -g

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

--service-name -n

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

--url-template

이 작업의 대상 리소스를 식별하는 상대 URL 템플릿입니다. 매개 변수를 포함할 수 있습니다.

선택적 매개 변수

--description

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

--if-match

엔터티의 ETag입니다.

--operation-id

API 내의 작업 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.

--params --template-parameters -p

URL 템플릿 매개 변수의 컬렉션입니다.

전역 매개 변수
--debug

로깅의 자세한 정도를 늘려 모든 디버그 로그를 표시합니다.

--help -h

이 도움말 메시지를 표시하고 종료합니다.

--only-show-errors

경고를 표시하지 않고 오류만 표시합니다.

--output -o

출력 형식입니다.

허용되는 값: json, jsonc, none, table, tsv, yaml, yamlc
기본값: json
--query

JMESPath 쿼리 문자열입니다. 자세한 내용과 예제는 http://jmespath.org/를 참조하세요.

--subscription

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

--verbose

로깅의 자세한 정도를 늘립니다. 전체 디버그 로그를 표시하려면 --debug를 사용합니다.

az apim api operation delete

편집

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

az apim api operation delete --api-id
                             --operation-id
                             --resource-group
                             --service-name
                             [--if-match]

예제

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

az apim api operation delete --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --operation-id MyOperationId

필수 매개 변수

--api-id

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

--operation-id

API 내의 작업 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.

--resource-group -g

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

--service-name -n

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

선택적 매개 변수

--if-match

엔터티의 ETag입니다.

전역 매개 변수
--debug

로깅의 자세한 정도를 늘려 모든 디버그 로그를 표시합니다.

--help -h

이 도움말 메시지를 표시하고 종료합니다.

--only-show-errors

경고를 표시하지 않고 오류만 표시합니다.

--output -o

출력 형식입니다.

허용되는 값: json, jsonc, none, table, tsv, yaml, yamlc
기본값: json
--query

JMESPath 쿼리 문자열입니다. 자세한 내용과 예제는 http://jmespath.org/를 참조하세요.

--subscription

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

--verbose

로깅의 자세한 정도를 늘립니다. 전체 디버그 로그를 표시하려면 --debug를 사용합니다.

az apim api operation list

편집

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

az apim api operation list --api-id
                           --resource-group
                           --service-name

예제

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

az apim api operation list --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId

필수 매개 변수

--api-id

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

--resource-group -g

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

--service-name -n

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

전역 매개 변수
--debug

로깅의 자세한 정도를 늘려 모든 디버그 로그를 표시합니다.

--help -h

이 도움말 메시지를 표시하고 종료합니다.

--only-show-errors

경고를 표시하지 않고 오류만 표시합니다.

--output -o

출력 형식입니다.

허용되는 값: json, jsonc, none, table, tsv, yaml, yamlc
기본값: json
--query

JMESPath 쿼리 문자열입니다. 자세한 내용과 예제는 http://jmespath.org/를 참조하세요.

--subscription

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

--verbose

로깅의 자세한 정도를 늘립니다. 전체 디버그 로그를 표시하려면 --debug를 사용합니다.

az apim api operation show

편집

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

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

예제

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

az apim api operation show --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --operation-id MyOperationId

필수 매개 변수

--api-id

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

--operation-id

API 내의 작업 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.

--resource-group -g

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

--service-name -n

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

전역 매개 변수
--debug

로깅의 자세한 정도를 늘려 모든 디버그 로그를 표시합니다.

--help -h

이 도움말 메시지를 표시하고 종료합니다.

--only-show-errors

경고를 표시하지 않고 오류만 표시합니다.

--output -o

출력 형식입니다.

허용되는 값: json, jsonc, none, table, tsv, yaml, yamlc
기본값: json
--query

JMESPath 쿼리 문자열입니다. 자세한 내용과 예제는 http://jmespath.org/를 참조하세요.

--subscription

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

--verbose

로깅의 자세한 정도를 늘립니다. 전체 디버그 로그를 표시하려면 --debug를 사용합니다.

az apim api operation update

편집

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

az apim api operation update --api-id
                             --operation-id
                             --resource-group
                             --service-name
                             [--add]
                             [--description]
                             [--display-name]
                             [--force-string]
                             [--if-match]
                             [--method]
                             [--remove]
                             [--set]
                             [--url-template]

예제

업데이트 메서드, 표시 이름, 식별자가 지정한 API의 작업에 대한 설명입니다.

az apim api operation update --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --operation-id MyOperationId --method "PUT" --display-name NewDisplayName --description NewDescription

필수 매개 변수

--api-id

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

--operation-id

API 내의 작업 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.

--resource-group -g

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

--service-name -n

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

선택적 매개 변수

--add

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

기본값: []
--description

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

--display-name

필수입니다. 작업 이름입니다.

--force-string

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

기본값: False
--if-match

엔터티의 ETag입니다.

--method

필수입니다. 유효한 HTTP 작업 메서드입니다. GET, PUT, POST와 같은 일반적인 Http 메서드이지만 이러한 메서드로만 제한되지는 않습니다.

--remove

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

기본값: []
--set

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

기본값: []
--url-template

이 작업의 대상 리소스를 식별하는 상대 URL 템플릿입니다. 매개 변수를 포함할 수 있습니다.

전역 매개 변수
--debug

로깅의 자세한 정도를 늘려 모든 디버그 로그를 표시합니다.

--help -h

이 도움말 메시지를 표시하고 종료합니다.

--only-show-errors

경고를 표시하지 않고 오류만 표시합니다.

--output -o

출력 형식입니다.

허용되는 값: json, jsonc, none, table, tsv, yaml, yamlc
기본값: json
--query

JMESPath 쿼리 문자열입니다. 자세한 내용과 예제는 http://jmespath.org/를 참조하세요.

--subscription

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

--verbose

로깅의 자세한 정도를 늘립니다. 전체 디버그 로그를 표시하려면 --debug를 사용합니다.