WorkspaceGlobalSchema interface

패키지:

@azure/arm-apimanagement

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

메서드

beginCreateOrUpdate(string, string, string, string, GlobalSchemaContract, WorkspaceGlobalSchemaCreateOrUpdateOptionalParams)	API Management 서비스 인스턴스에서 작업 영역의 기존 지정된 스키마를 새로 만들거나 업데이트합니다.
beginCreateOrUpdateAndWait(string, string, string, string, GlobalSchemaContract, WorkspaceGlobalSchemaCreateOrUpdateOptionalParams)	API Management 서비스 인스턴스에서 작업 영역의 기존 지정된 스키마를 새로 만들거나 업데이트합니다.
delete(string, string, string, string, string, WorkspaceGlobalSchemaDeleteOptionalParams)	특정 스키마를 삭제합니다.
get(string, string, string, string, WorkspaceGlobalSchemaGetOptionalParams)	식별자가 지정한 스키마의 세부 정보를 가져옵니다.
getEntityTag(string, string, string, string, WorkspaceGlobalSchemaGetEntityTagOptionalParams)	식별자가 지정한 스키마의 Etag(엔터티 상태) 버전을 가져옵니다.
listByService(string, string, string, WorkspaceGlobalSchemaListByServiceOptionalParams)	서비스 인스턴스의 작업 영역에 등록된 스키마 컬렉션을 나열합니다.

메서드 세부 정보

beginCreateOrUpdate(string, string, string, string, GlobalSchemaContract, WorkspaceGlobalSchemaCreateOrUpdateOptionalParams)

API Management 서비스 인스턴스에서 작업 영역의 기존 지정된 스키마를 새로 만들거나 업데이트합니다.

function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, schemaId: string, parameters: GlobalSchemaContract, options?: WorkspaceGlobalSchemaCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WorkspaceGlobalSchemaCreateOrUpdateResponse>, WorkspaceGlobalSchemaCreateOrUpdateResponse>>

매개 변수

resourceGroupName

string

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

serviceName

string

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

workspaceId

string

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

schemaId

string

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

parameters

GlobalSchemaContract

매개 변수를 만들거나 업데이트합니다.

options

WorkspaceGlobalSchemaCreateOrUpdateOptionalParams

옵션 매개 변수입니다.

반환

Promise<@azure/core-lro.SimplePollerLike<OperationState<WorkspaceGlobalSchemaCreateOrUpdateResponse>, WorkspaceGlobalSchemaCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait(string, string, string, string, GlobalSchemaContract, WorkspaceGlobalSchemaCreateOrUpdateOptionalParams)

API Management 서비스 인스턴스에서 작업 영역의 기존 지정된 스키마를 새로 만들거나 업데이트합니다.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, workspaceId: string, schemaId: string, parameters: GlobalSchemaContract, options?: WorkspaceGlobalSchemaCreateOrUpdateOptionalParams): Promise<WorkspaceGlobalSchemaCreateOrUpdateResponse>

매개 변수

resourceGroupName

string

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

serviceName

string

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

workspaceId

string

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

schemaId

string

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

parameters

GlobalSchemaContract

매개 변수를 만들거나 업데이트합니다.

options

WorkspaceGlobalSchemaCreateOrUpdateOptionalParams

옵션 매개 변수입니다.

반환

Promise<WorkspaceGlobalSchemaCreateOrUpdateResponse>

delete(string, string, string, string, string, WorkspaceGlobalSchemaDeleteOptionalParams)

특정 스키마를 삭제합니다.

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

매개 변수

resourceGroupName

string

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

serviceName

string

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

workspaceId

string

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

schemaId

string

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

ifMatch

string

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

options

WorkspaceGlobalSchemaDeleteOptionalParams

옵션 매개 변수입니다.

반환

Promise<void>

get(string, string, string, string, WorkspaceGlobalSchemaGetOptionalParams)

식별자가 지정한 스키마의 세부 정보를 가져옵니다.

function get(resourceGroupName: string, serviceName: string, workspaceId: string, schemaId: string, options?: WorkspaceGlobalSchemaGetOptionalParams): Promise<WorkspaceGlobalSchemaGetResponse>

매개 변수

resourceGroupName

string

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

serviceName

string

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

workspaceId

string

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

schemaId

string

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

options

WorkspaceGlobalSchemaGetOptionalParams

옵션 매개 변수입니다.

반환

Promise<WorkspaceGlobalSchemaGetResponse>

getEntityTag(string, string, string, string, WorkspaceGlobalSchemaGetEntityTagOptionalParams)

식별자가 지정한 스키마의 Etag(엔터티 상태) 버전을 가져옵니다.

function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, schemaId: string, options?: WorkspaceGlobalSchemaGetEntityTagOptionalParams): Promise<WorkspaceGlobalSchemaGetEntityTagHeaders>

매개 변수

resourceGroupName

string

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

serviceName

string

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

workspaceId

string

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

schemaId

string

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

options

WorkspaceGlobalSchemaGetEntityTagOptionalParams

옵션 매개 변수입니다.

반환

Promise<WorkspaceGlobalSchemaGetEntityTagHeaders>

listByService(string, string, string, WorkspaceGlobalSchemaListByServiceOptionalParams)

서비스 인스턴스의 작업 영역에 등록된 스키마 컬렉션을 나열합니다.

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

매개 변수

resourceGroupName

string

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

serviceName

string

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

workspaceId

string

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

options

WorkspaceGlobalSchemaListByServiceOptionalParams

옵션 매개 변수입니다.

반환

PagedAsyncIterableIterator<GlobalSchemaContract, GlobalSchemaContract[], PageSettings>