WorkspaceTag interface

패키지:

@azure/arm-apimanagement

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

메서드

createOrUpdate(string, string, string, string, TagCreateUpdateParameters, WorkspaceTagCreateOrUpdateOptionalParams)	태그를 만듭니다.
delete(string, string, string, string, string, WorkspaceTagDeleteOptionalParams)	API Management 서비스 인스턴스에서 작업 영역의 특정 태그를 삭제합니다.
get(string, string, string, string, WorkspaceTagGetOptionalParams)	식별자가 지정한 태그의 세부 정보를 가져옵니다.
getEntityState(string, string, string, string, WorkspaceTagGetEntityStateOptionalParams)	식별자가 지정한 태그의 엔터티 상태 버전을 가져옵니다.
listByService(string, string, string, WorkspaceTagListByServiceOptionalParams)	서비스 인스턴스의 작업 영역 내에 정의된 태그 컬렉션을 나열합니다.
update(string, string, string, string, string, TagCreateUpdateParameters, WorkspaceTagUpdateOptionalParams)	식별자가 지정한 태그의 세부 정보를 업데이트합니다.

메서드 세부 정보

createOrUpdate(string, string, string, string, TagCreateUpdateParameters, WorkspaceTagCreateOrUpdateOptionalParams)

태그를 만듭니다.

function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, tagId: string, parameters: TagCreateUpdateParameters, options?: WorkspaceTagCreateOrUpdateOptionalParams): Promise<WorkspaceTagCreateOrUpdateResponse>

매개 변수

resourceGroupName

string

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

serviceName

string

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

workspaceId

string

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

tagId

string

태그 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.

parameters

TagCreateUpdateParameters

매개 변수를 만듭니다.

options

WorkspaceTagCreateOrUpdateOptionalParams

옵션 매개 변수입니다.

반환

Promise<WorkspaceTagCreateOrUpdateResponse>

delete(string, string, string, string, string, WorkspaceTagDeleteOptionalParams)

API Management 서비스 인스턴스에서 작업 영역의 특정 태그를 삭제합니다.

function delete(resourceGroupName: string, serviceName: string, workspaceId: string, tagId: string, ifMatch: string, options?: WorkspaceTagDeleteOptionalParams): Promise<void>

매개 변수

resourceGroupName

string

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

serviceName

string

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

workspaceId

string

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

tagId

string

태그 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.

ifMatch

string

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

options

WorkspaceTagDeleteOptionalParams

옵션 매개 변수입니다.

반환

Promise<void>

get(string, string, string, string, WorkspaceTagGetOptionalParams)

식별자가 지정한 태그의 세부 정보를 가져옵니다.

function get(resourceGroupName: string, serviceName: string, workspaceId: string, tagId: string, options?: WorkspaceTagGetOptionalParams): Promise<WorkspaceTagGetResponse>

매개 변수

resourceGroupName

string

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

serviceName

string

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

workspaceId

string

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

tagId

string

태그 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.

options

WorkspaceTagGetOptionalParams

옵션 매개 변수입니다.

반환

Promise<WorkspaceTagGetResponse>

getEntityState(string, string, string, string, WorkspaceTagGetEntityStateOptionalParams)

식별자가 지정한 태그의 엔터티 상태 버전을 가져옵니다.

function getEntityState(resourceGroupName: string, serviceName: string, workspaceId: string, tagId: string, options?: WorkspaceTagGetEntityStateOptionalParams): Promise<WorkspaceTagGetEntityStateHeaders>

매개 변수

resourceGroupName

string

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

serviceName

string

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

workspaceId

string

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

tagId

string

태그 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.

options

WorkspaceTagGetEntityStateOptionalParams

옵션 매개 변수입니다.

반환

Promise<WorkspaceTagGetEntityStateHeaders>

listByService(string, string, string, WorkspaceTagListByServiceOptionalParams)

서비스 인스턴스의 작업 영역 내에 정의된 태그 컬렉션을 나열합니다.

function listByService(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceTagListByServiceOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

매개 변수

resourceGroupName

string

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

serviceName

string

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

workspaceId

string

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

options

WorkspaceTagListByServiceOptionalParams

옵션 매개 변수입니다.

반환

PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

update(string, string, string, string, string, TagCreateUpdateParameters, WorkspaceTagUpdateOptionalParams)

식별자가 지정한 태그의 세부 정보를 업데이트합니다.

function update(resourceGroupName: string, serviceName: string, workspaceId: string, tagId: string, ifMatch: string, parameters: TagCreateUpdateParameters, options?: WorkspaceTagUpdateOptionalParams): Promise<WorkspaceTagUpdateResponse>

매개 변수

resourceGroupName

string

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

serviceName

string

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

workspaceId

string

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

tagId

string

태그 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.

ifMatch

string

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

parameters

TagCreateUpdateParameters

매개 변수를 업데이트합니다.

options

WorkspaceTagUpdateOptionalParams

옵션 매개 변수입니다.

반환

Promise<WorkspaceTagUpdateResponse>