az apim api operation
Azure API Management API 작업을 관리 합니다.
명령
| az apim api operation create |
API에서 새 작업을 만듭니다. |
| az apim api operation delete |
API에서 지정된 작업을 삭제합니다. |
| az apim api operation list |
지정 된 API에 대 한 작업 컬렉션을 나열 합니다. |
| az apim api operation show |
해당 식별자로 지정 된 API 작업에 대 한 세부 정보를 가져옵니다. |
| az apim api operation update |
해당 식별자로 지정 된 API의 작업 세부 정보를 업데이트 합니다. |
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]
[--subscription]
예제
여러 매개 변수를 사용 하 여 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 Management 서비스 인스턴스에서 고유 해야 합니다. 현재 값이 아닌 수정 버전은입니다. 여기서 n은 수정 번호입니다. 여기서 n은 수정 번호입니다.
필수 요소. 작업 이름입니다.
필수 요소. 유효한 HTTP 작업 메서드입니다. GET, PUT, POST와 같은 일반적인 Http 메서드 및이에 의해서만 제한 되지 않습니다.
리소스 그룹의 이름입니다. az configure --defaults group=<name>을 사용하여 기본 그룹을 구성할 수 있습니다.
API Management 서비스 인스턴스의 이름입니다.
이 작업에 대한 대상 리소스를 식별하는 상대 URL 템플릿입니다. 매개 변수를 포함할 수 있습니다.
선택적 매개 변수
작업에 대한 설명입니다. HTML 서식 지정 태그를 포함할 수 있습니다.
엔터티의 ETag입니다.
API 내의 작업 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유 해야 합니다.
URL 템플릿 매개 변수의 컬렉션입니다.
구독의 이름 또는 ID입니다. 을 사용 하 여 기본 구독을 구성할 수 있습니다 az account set -s NAME_OR_ID .
로깅의 자세한 정도를 늘려 모든 디버그 로그를 표시합니다.
이 도움말 메시지를 표시하고 종료합니다.
오류만 표시하고, 경고를 표시하지 않습니다.
출력 형식입니다.
JMESPath 쿼리 문자열입니다. 자세한 내용 및 예제는 http://jmespath.org/를 참조하세요.
로깅의 자세한 정도를 늘립니다. 전체 디버그 로그를 표시하려면 --debug를 사용합니다.
az apim api operation delete
API에서 지정된 작업을 삭제합니다.
az apim api operation delete --api-id
--operation-id
--resource-group
--service-name
[--if-match]
[--subscription]
예제
API에서 지정된 작업을 삭제합니다.
az apim api operation delete --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --operation-id MyOperationId
필수 매개 변수
API ID입니다. 현재 API Management 서비스 인스턴스에서 고유 해야 합니다. 현재 값이 아닌 수정 버전은입니다. 여기서 n은 수정 번호입니다. 여기서 n은 수정 번호입니다.
API 내의 작업 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유 해야 합니다.
리소스 그룹의 이름입니다. az configure --defaults group=<name>을 사용하여 기본 그룹을 구성할 수 있습니다.
API Management 서비스 인스턴스의 이름입니다.
선택적 매개 변수
엔터티의 ETag입니다.
구독의 이름 또는 ID입니다. 을 사용 하 여 기본 구독을 구성할 수 있습니다 az account set -s NAME_OR_ID .
로깅의 자세한 정도를 늘려 모든 디버그 로그를 표시합니다.
이 도움말 메시지를 표시하고 종료합니다.
오류만 표시하고, 경고를 표시하지 않습니다.
출력 형식입니다.
JMESPath 쿼리 문자열입니다. 자세한 내용 및 예제는 http://jmespath.org/를 참조하세요.
로깅의 자세한 정도를 늘립니다. 전체 디버그 로그를 표시하려면 --debug를 사용합니다.
az apim api operation list
지정 된 API에 대 한 작업 컬렉션을 나열 합니다.
az apim api operation list --api-id
--resource-group
--service-name
[--query-examples]
[--subscription]
예제
지정 된 API에 대 한 작업 컬렉션을 나열 합니다.
az apim api operation list --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId
필수 매개 변수
API ID입니다. 현재 API Management 서비스 인스턴스에서 고유 해야 합니다. 현재 값이 아닌 수정 버전은입니다. 여기서 n은 수정 번호입니다. 여기서 n은 수정 번호입니다.
리소스 그룹의 이름입니다. az configure --defaults group=<name>을 사용하여 기본 그룹을 구성할 수 있습니다.
API Management 서비스 인스턴스의 이름입니다.
선택적 매개 변수
JMESPath 문자열을 권장 합니다. 쿼리 중 하나를 복사 하 여 결과를 볼 수 있도록 큰따옴표 내에서--query 매개 변수 뒤에 붙여 넣을 수 있습니다. 이러한 주요 단어를 기준으로 제안을 제공할 수 있도록 하나 이상의 위치 키워드를 추가할 수 있습니다.
구독의 이름 또는 ID입니다. 을 사용 하 여 기본 구독을 구성할 수 있습니다 az account set -s NAME_OR_ID .
로깅의 자세한 정도를 늘려 모든 디버그 로그를 표시합니다.
이 도움말 메시지를 표시하고 종료합니다.
오류만 표시하고, 경고를 표시하지 않습니다.
출력 형식입니다.
JMESPath 쿼리 문자열입니다. 자세한 내용 및 예제는 http://jmespath.org/를 참조하세요.
로깅의 자세한 정도를 늘립니다. 전체 디버그 로그를 표시하려면 --debug를 사용합니다.
az apim api operation show
해당 식별자로 지정 된 API 작업에 대 한 세부 정보를 가져옵니다.
az apim api operation show --api-id
--operation-id
--resource-group
--service-name
[--query-examples]
[--subscription]
예제
해당 식별자로 지정 된 API 작업에 대 한 세부 정보를 가져옵니다.
az apim api operation show --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --operation-id MyOperationId
필수 매개 변수
API ID입니다. 현재 API Management 서비스 인스턴스에서 고유 해야 합니다. 현재 값이 아닌 수정 버전은입니다. 여기서 n은 수정 번호입니다. 여기서 n은 수정 번호입니다.
API 내의 작업 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유 해야 합니다.
리소스 그룹의 이름입니다. az configure --defaults group=<name>을 사용하여 기본 그룹을 구성할 수 있습니다.
API Management 서비스 인스턴스의 이름입니다.
선택적 매개 변수
JMESPath 문자열을 권장 합니다. 쿼리 중 하나를 복사 하 여 결과를 볼 수 있도록 큰따옴표 내에서--query 매개 변수 뒤에 붙여 넣을 수 있습니다. 이러한 주요 단어를 기준으로 제안을 제공할 수 있도록 하나 이상의 위치 키워드를 추가할 수 있습니다.
구독의 이름 또는 ID입니다. 을 사용 하 여 기본 구독을 구성할 수 있습니다 az account set -s NAME_OR_ID .
로깅의 자세한 정도를 늘려 모든 디버그 로그를 표시합니다.
이 도움말 메시지를 표시하고 종료합니다.
오류만 표시하고, 경고를 표시하지 않습니다.
출력 형식입니다.
JMESPath 쿼리 문자열입니다. 자세한 내용 및 예제는 http://jmespath.org/를 참조하세요.
로깅의 자세한 정도를 늘립니다. 전체 디버그 로그를 표시하려면 --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]
[--subscription]
[--url-template]
예제
식별자로 지정 된 API에서 작업에 대 한 메서드, displayname, 설명을 업데이트 합니다.
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 Management 서비스 인스턴스에서 고유 해야 합니다. 현재 값이 아닌 수정 버전은입니다. 여기서 n은 수정 번호입니다. 여기서 n은 수정 번호입니다.
API 내의 작업 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유 해야 합니다.
리소스 그룹의 이름입니다. az configure --defaults group=<name>을 사용하여 기본 그룹을 구성할 수 있습니다.
API Management 서비스 인스턴스의 이름입니다.
선택적 매개 변수
경로 및 키 값 쌍을 지정 하 여 개체 목록에 개체를 추가 합니다. 예:--속성을 추가 합니다. listProperty <key = value, string 또는 JSON string>.
작업에 대한 설명입니다. HTML 서식 지정 태그를 포함할 수 있습니다.
필수 요소. 작업 이름입니다.
' Set ' 또는 ' a l l '을 사용 하는 경우 JSON으로 변환 하는 대신 문자열 리터럴을 유지 합니다.
엔터티의 ETag입니다.
필수 요소. 유효한 HTTP 작업 메서드입니다. GET, PUT, POST와 같은 일반적인 Http 메서드 및이에 의해서만 제한 되지 않습니다.
목록에서 속성이 나 요소를 제거 합니다. 예:--속성을 제거 합니다. 목록 또는--propertyToRemove을 제거 합니다.
설정할 속성 경로 및 값을 지정 하 여 개체를 업데이트 합니다. 예:--set property1 property2 =.
구독의 이름 또는 ID입니다. 을 사용 하 여 기본 구독을 구성할 수 있습니다 az account set -s NAME_OR_ID .
이 작업에 대한 대상 리소스를 식별하는 상대 URL 템플릿입니다. 매개 변수를 포함할 수 있습니다.
로깅의 자세한 정도를 늘려 모든 디버그 로그를 표시합니다.
이 도움말 메시지를 표시하고 종료합니다.
오류만 표시하고, 경고를 표시하지 않습니다.
출력 형식입니다.
JMESPath 쿼리 문자열입니다. 자세한 내용 및 예제는 http://jmespath.org/를 참조하세요.
로깅의 자세한 정도를 늘립니다. 전체 디버그 로그를 표시하려면 --debug를 사용합니다.