ApiPolicy interface
ApiPolicy를 나타내는 인터페이스입니다.
메서드
| create |
API에 대한 정책 구성을 만들거나 업데이트합니다. |
| delete(string, string, string, string, string, Api |
API에서 정책 구성을 삭제합니다. |
| get(string, string, string, string, Api |
API 수준에서 정책 구성을 가져옵니다. |
| get |
식별자가 지정한 API 정책의 엔터티 상태(Etag) 버전을 가져옵니다. |
| list |
API 수준에서 정책 구성을 가져옵니다. |
메서드 세부 정보
createOrUpdate(string, string, string, string, PolicyContract, ApiPolicyCreateOrUpdateOptionalParams)
API에 대한 정책 구성을 만들거나 업데이트합니다.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, parameters: PolicyContract, options?: ApiPolicyCreateOrUpdateOptionalParams): Promise<ApiPolicyCreateOrUpdateResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- apiId
-
string
API 수정 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 접미사로 ;rev=n이 있습니다. 여기서 n은 수정 번호입니다.
- policyId
-
string
정책의 식별자입니다.
- parameters
- PolicyContract
적용할 정책 콘텐츠입니다.
옵션 매개 변수입니다.
반환
Promise<ApiPolicyCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiPolicyDeleteOptionalParams)
API에서 정책 구성을 삭제합니다.
function delete(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, ifMatch: string, options?: ApiPolicyDeleteOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- apiId
-
string
API 수정 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 접미사로 ;rev=n이 있습니다. 여기서 n은 수정 번호입니다.
- policyId
-
string
정책의 식별자입니다.
- ifMatch
-
string
엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.
- options
- ApiPolicyDeleteOptionalParams
옵션 매개 변수입니다.
반환
Promise<void>
get(string, string, string, string, ApiPolicyGetOptionalParams)
API 수준에서 정책 구성을 가져옵니다.
function get(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, options?: ApiPolicyGetOptionalParams): Promise<ApiPolicyGetResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- apiId
-
string
API 수정 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 접미사로 ;rev=n이 있습니다. 여기서 n은 수정 번호입니다.
- policyId
-
string
정책의 식별자입니다.
- options
- ApiPolicyGetOptionalParams
옵션 매개 변수입니다.
반환
Promise<ApiPolicyGetResponse>
getEntityTag(string, string, string, string, ApiPolicyGetEntityTagOptionalParams)
식별자가 지정한 API 정책의 엔터티 상태(Etag) 버전을 가져옵니다.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, options?: ApiPolicyGetEntityTagOptionalParams): Promise<ApiPolicyGetEntityTagHeaders>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- apiId
-
string
API 수정 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 접미사로 ;rev=n이 있습니다. 여기서 n은 수정 번호입니다.
- policyId
-
string
정책의 식별자입니다.
옵션 매개 변수입니다.
반환
Promise<ApiPolicyGetEntityTagHeaders>
listByApi(string, string, string, ApiPolicyListByApiOptionalParams)
API 수준에서 정책 구성을 가져옵니다.
function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiPolicyListByApiOptionalParams): Promise<PolicyCollection>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- apiId
-
string
API 수정 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 접미사로 ;rev=n이 있습니다. 여기서 n은 수정 번호입니다.
- options
- ApiPolicyListByApiOptionalParams
옵션 매개 변수입니다.
반환
Promise<PolicyCollection>