WorkspaceApiSchema interface
WorkspaceApiSchema를 나타내는 인터페이스입니다.
메서드
| begin |
API에 대한 스키마 구성을 만들거나 업데이트합니다. |
| begin |
API에 대한 스키마 구성을 만들거나 업데이트합니다. |
| delete(string, string, string, string, string, string, Workspace |
API에서 스키마 구성을 삭제합니다. |
| get(string, string, string, string, string, Workspace |
API 수준에서 스키마 구성을 가져옵니다. |
| get |
식별자가 지정한 스키마의 Etag(엔터티 상태) 버전을 가져옵니다. |
| list |
API 수준에서 스키마 구성을 가져옵니다. |
메서드 세부 정보
beginCreateOrUpdate(string, string, string, string, string, SchemaContract, WorkspaceApiSchemaCreateOrUpdateOptionalParams)
API에 대한 스키마 구성을 만들거나 업데이트합니다.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: WorkspaceApiSchemaCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WorkspaceApiSchemaCreateOrUpdateResponse>, WorkspaceApiSchemaCreateOrUpdateResponse>>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- workspaceId
-
string
작업 영역 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- apiId
-
string
API 수정 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 다음이 있습니다. rev=n은 접미사로, n은 수정 번호입니다.
- schemaId
-
string
스키마 ID 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- parameters
- SchemaContract
적용할 스키마 내용입니다.
옵션 매개 변수입니다.
반환
Promise<@azure/core-lro.SimplePollerLike<OperationState<WorkspaceApiSchemaCreateOrUpdateResponse>, WorkspaceApiSchemaCreateOrUpdateResponse>>
beginCreateOrUpdateAndWait(string, string, string, string, string, SchemaContract, WorkspaceApiSchemaCreateOrUpdateOptionalParams)
API에 대한 스키마 구성을 만들거나 업데이트합니다.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: WorkspaceApiSchemaCreateOrUpdateOptionalParams): Promise<WorkspaceApiSchemaCreateOrUpdateResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- workspaceId
-
string
작업 영역 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- apiId
-
string
API 수정 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 다음이 있습니다. rev=n은 접미사로, n은 수정 번호입니다.
- schemaId
-
string
스키마 ID 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- parameters
- SchemaContract
적용할 스키마 내용입니다.
옵션 매개 변수입니다.
반환
delete(string, string, string, string, string, string, WorkspaceApiSchemaDeleteOptionalParams)
API에서 스키마 구성을 삭제합니다.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, schemaId: string, ifMatch: string, options?: WorkspaceApiSchemaDeleteOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- workspaceId
-
string
작업 영역 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- apiId
-
string
API 수정 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 다음이 있습니다. rev=n은 접미사로, n은 수정 번호입니다.
- schemaId
-
string
스키마 ID 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- ifMatch
-
string
엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.
옵션 매개 변수입니다.
반환
Promise<void>
get(string, string, string, string, string, WorkspaceApiSchemaGetOptionalParams)
API 수준에서 스키마 구성을 가져옵니다.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, schemaId: string, options?: WorkspaceApiSchemaGetOptionalParams): Promise<WorkspaceApiSchemaGetResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- workspaceId
-
string
작업 영역 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- apiId
-
string
API 수정 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 다음이 있습니다. rev=n은 접미사로, n은 수정 번호입니다.
- schemaId
-
string
스키마 ID 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
옵션 매개 변수입니다.
반환
Promise<WorkspaceApiSchemaGetResponse>
getEntityTag(string, string, string, string, string, WorkspaceApiSchemaGetEntityTagOptionalParams)
식별자가 지정한 스키마의 Etag(엔터티 상태) 버전을 가져옵니다.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, schemaId: string, options?: WorkspaceApiSchemaGetEntityTagOptionalParams): Promise<WorkspaceApiSchemaGetEntityTagHeaders>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- workspaceId
-
string
작업 영역 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- apiId
-
string
API 수정 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 다음이 있습니다. rev=n은 접미사로, n은 수정 번호입니다.
- schemaId
-
string
스키마 ID 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
옵션 매개 변수입니다.
반환
listByApi(string, string, string, string, WorkspaceApiSchemaListByApiOptionalParams)
API 수준에서 스키마 구성을 가져옵니다.
function listByApi(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiSchemaListByApiOptionalParams): PagedAsyncIterableIterator<SchemaContract, SchemaContract[], PageSettings>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- workspaceId
-
string
작업 영역 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- apiId
-
string
API 수정 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 다음이 있습니다. rev=n은 접미사로, n은 수정 번호입니다.
옵션 매개 변수입니다.