Workspace interface
작업 공간을 나타내는 인터페이스입니다.
메서드
| create |
새 작업 영역을 만들거나 기존 작업 영역을 업데이트합니다. |
| delete(string, string, string, string, Workspace |
지정된 작업 영역을 삭제합니다. |
| get(string, string, string, Workspace |
식별자가 지정한 작업 영역의 세부 정보를 가져옵니다. |
| get |
식별자가 지정한 작업 영역의 Etag(엔터티 상태) 버전을 가져옵니다. |
| list |
API Management 서비스 인스턴스의 모든 작업 영역을 나열합니다. |
| update(string, string, string, string, Workspace |
식별자가 지정한 작업 영역의 세부 정보를 업데이트합니다. |
메서드 세부 정보
createOrUpdate(string, string, string, WorkspaceContract, WorkspaceCreateOrUpdateOptionalParams)
새 작업 영역을 만들거나 기존 작업 영역을 업데이트합니다.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, parameters: WorkspaceContract, options?: WorkspaceCreateOrUpdateOptionalParams): Promise<WorkspaceCreateOrUpdateResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- workspaceId
-
string
작업 영역 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- parameters
- WorkspaceContract
매개 변수를 만듭니다.
옵션 매개 변수입니다.
반환
Promise<WorkspaceCreateOrUpdateResponse>
delete(string, string, string, string, WorkspaceDeleteOptionalParams)
지정된 작업 영역을 삭제합니다.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, ifMatch: string, options?: WorkspaceDeleteOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- workspaceId
-
string
작업 영역 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- ifMatch
-
string
엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.
- options
- WorkspaceDeleteOptionalParams
옵션 매개 변수입니다.
반환
Promise<void>
get(string, string, string, WorkspaceGetOptionalParams)
식별자가 지정한 작업 영역의 세부 정보를 가져옵니다.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceGetOptionalParams): Promise<WorkspaceGetResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- workspaceId
-
string
작업 영역 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- options
- WorkspaceGetOptionalParams
옵션 매개 변수입니다.
반환
Promise<WorkspaceGetResponse>
getEntityTag(string, string, string, WorkspaceGetEntityTagOptionalParams)
식별자가 지정한 작업 영역의 Etag(엔터티 상태) 버전을 가져옵니다.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceGetEntityTagOptionalParams): Promise<WorkspaceGetEntityTagHeaders>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- workspaceId
-
string
작업 영역 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
옵션 매개 변수입니다.
반환
Promise<WorkspaceGetEntityTagHeaders>
listByService(string, string, WorkspaceListByServiceOptionalParams)
API Management 서비스 인스턴스의 모든 작업 영역을 나열합니다.
function listByService(resourceGroupName: string, serviceName: string, options?: WorkspaceListByServiceOptionalParams): PagedAsyncIterableIterator<WorkspaceContract, WorkspaceContract[], PageSettings>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
옵션 매개 변수입니다.
반환
update(string, string, string, string, WorkspaceContract, WorkspaceUpdateOptionalParams)
식별자가 지정한 작업 영역의 세부 정보를 업데이트합니다.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, ifMatch: string, parameters: WorkspaceContract, options?: WorkspaceUpdateOptionalParams): Promise<WorkspaceUpdateResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- workspaceId
-
string
작업 영역 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- ifMatch
-
string
엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.
- parameters
- WorkspaceContract
작업 영역 업데이트 매개 변수.
- options
- WorkspaceUpdateOptionalParams
옵션 매개 변수입니다.
반환
Promise<WorkspaceUpdateResponse>