WorkspaceApiOperationPolicy interface

패키지:

@azure/arm-apimanagement

WorkspaceApiOperationPolicy를 나타내는 인터페이스입니다.

메서드

createOrUpdate(string, string, string, string, string, string, PolicyContract, WorkspaceApiOperationPolicyCreateOrUpdateOptionalParams)	API 작업 수준에서 정책 구성을 만들거나 업데이트합니다.
delete(string, string, string, string, string, string, string, WorkspaceApiOperationPolicyDeleteOptionalParams)	API 작업에서 정책 구성을 삭제합니다.
get(string, string, string, string, string, string, WorkspaceApiOperationPolicyGetOptionalParams)	API 작업 수준에서 정책 구성을 가져옵니다.
getEntityTag(string, string, string, string, string, string, WorkspaceApiOperationPolicyGetEntityTagOptionalParams)	식별자가 지정한 API 작업 정책의 Etag(엔터티 상태) 버전을 가져옵니다.
listByOperation(string, string, string, string, string, WorkspaceApiOperationPolicyListByOperationOptionalParams)	API 작업 수준에서 정책 구성 목록을 가져옵니다.

메서드 세부 정보

createOrUpdate(string, string, string, string, string, string, PolicyContract, WorkspaceApiOperationPolicyCreateOrUpdateOptionalParams)

API 작업 수준에서 정책 구성을 만들거나 업데이트합니다.

function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, policyId: string, parameters: PolicyContract, options?: WorkspaceApiOperationPolicyCreateOrUpdateOptionalParams): Promise<WorkspaceApiOperationPolicyCreateOrUpdateResponse>

매개 변수

resourceGroupName

string

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

serviceName

string

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

workspaceId

string

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

apiId

string

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

operationId

string

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

policyId

string

정책의 식별자입니다.

parameters

PolicyContract

적용할 정책 내용입니다.

options

WorkspaceApiOperationPolicyCreateOrUpdateOptionalParams

옵션 매개 변수입니다.

반환

Promise<WorkspaceApiOperationPolicyCreateOrUpdateResponse>

delete(string, string, string, string, string, string, string, WorkspaceApiOperationPolicyDeleteOptionalParams)

API 작업에서 정책 구성을 삭제합니다.

function delete(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, policyId: string, ifMatch: string, options?: WorkspaceApiOperationPolicyDeleteOptionalParams): Promise<void>

매개 변수

resourceGroupName

string

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

serviceName

string

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

workspaceId

string

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

apiId

string

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

operationId

string

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

policyId

string

정책의 식별자입니다.

ifMatch

string

엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.

options

WorkspaceApiOperationPolicyDeleteOptionalParams

옵션 매개 변수입니다.

반환

Promise<void>

get(string, string, string, string, string, string, WorkspaceApiOperationPolicyGetOptionalParams)

API 작업 수준에서 정책 구성을 가져옵니다.

function get(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, policyId: string, options?: WorkspaceApiOperationPolicyGetOptionalParams): Promise<WorkspaceApiOperationPolicyGetResponse>

매개 변수

resourceGroupName

string

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

serviceName

string

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

workspaceId

string

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

apiId

string

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

operationId

string

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

policyId

string

정책의 식별자입니다.

options

WorkspaceApiOperationPolicyGetOptionalParams

옵션 매개 변수입니다.

반환

Promise<WorkspaceApiOperationPolicyGetResponse>

getEntityTag(string, string, string, string, string, string, WorkspaceApiOperationPolicyGetEntityTagOptionalParams)

식별자가 지정한 API 작업 정책의 Etag(엔터티 상태) 버전을 가져옵니다.

function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, policyId: string, options?: WorkspaceApiOperationPolicyGetEntityTagOptionalParams): Promise<WorkspaceApiOperationPolicyGetEntityTagHeaders>

매개 변수

resourceGroupName

string

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

serviceName

string

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

workspaceId

string

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

apiId

string

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

operationId

string

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

policyId

string

정책의 식별자입니다.

options

WorkspaceApiOperationPolicyGetEntityTagOptionalParams

옵션 매개 변수입니다.

반환

Promise<WorkspaceApiOperationPolicyGetEntityTagHeaders>

listByOperation(string, string, string, string, string, WorkspaceApiOperationPolicyListByOperationOptionalParams)

API 작업 수준에서 정책 구성 목록을 가져옵니다.

function listByOperation(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, options?: WorkspaceApiOperationPolicyListByOperationOptionalParams): PagedAsyncIterableIterator<PolicyContract, PolicyContract[], PageSettings>

매개 변수

resourceGroupName

string

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

serviceName

string

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

workspaceId

string

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

apiId

string

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

operationId

string

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

options

WorkspaceApiOperationPolicyListByOperationOptionalParams

옵션 매개 변수입니다.

반환

PagedAsyncIterableIterator<PolicyContract, PolicyContract[], PageSettings>