WorkspaceGroup interface
WorkspaceGroup을 나타내는 인터페이스입니다.
메서드
| create |
그룹을 만들거나 업데이트합니다. |
| delete(string, string, string, string, string, Workspace |
API Management 서비스 인스턴스에서 작업 영역의 특정 그룹을 삭제합니다. |
| get(string, string, string, string, Workspace |
식별자가 지정한 그룹의 세부 정보를 가져옵니다. |
| get |
식별자가 지정한 그룹의 Etag(엔터티 상태) 버전을 가져옵니다. |
| list |
서비스 인스턴스의 작업 영역 내에 정의된 그룹 컬렉션을 나열합니다. |
| update(string, string, string, string, string, Group |
식별자가 지정한 그룹의 세부 정보를 업데이트합니다. |
메서드 세부 정보
createOrUpdate(string, string, string, string, GroupCreateParameters, WorkspaceGroupCreateOrUpdateOptionalParams)
그룹을 만들거나 업데이트합니다.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, parameters: GroupCreateParameters, options?: WorkspaceGroupCreateOrUpdateOptionalParams): Promise<WorkspaceGroupCreateOrUpdateResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- workspaceId
-
string
작업 영역 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- groupId
-
string
그룹 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- parameters
- GroupCreateParameters
매개 변수를 만듭니다.
옵션 매개 변수입니다.
반환
Promise<WorkspaceGroupCreateOrUpdateResponse>
delete(string, string, string, string, string, WorkspaceGroupDeleteOptionalParams)
API Management 서비스 인스턴스에서 작업 영역의 특정 그룹을 삭제합니다.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, ifMatch: string, options?: WorkspaceGroupDeleteOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- workspaceId
-
string
작업 영역 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- groupId
-
string
그룹 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- ifMatch
-
string
엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.
옵션 매개 변수입니다.
반환
Promise<void>
get(string, string, string, string, WorkspaceGroupGetOptionalParams)
식별자가 지정한 그룹의 세부 정보를 가져옵니다.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, options?: WorkspaceGroupGetOptionalParams): Promise<WorkspaceGroupGetResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- workspaceId
-
string
작업 영역 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- groupId
-
string
그룹 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- options
- WorkspaceGroupGetOptionalParams
옵션 매개 변수입니다.
반환
Promise<WorkspaceGroupGetResponse>
getEntityTag(string, string, string, string, WorkspaceGroupGetEntityTagOptionalParams)
식별자가 지정한 그룹의 Etag(엔터티 상태) 버전을 가져옵니다.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, options?: WorkspaceGroupGetEntityTagOptionalParams): Promise<WorkspaceGroupGetEntityTagHeaders>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- workspaceId
-
string
작업 영역 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- groupId
-
string
그룹 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
옵션 매개 변수입니다.
반환
Promise<WorkspaceGroupGetEntityTagHeaders>
listByService(string, string, string, WorkspaceGroupListByServiceOptionalParams)
서비스 인스턴스의 작업 영역 내에 정의된 그룹 컬렉션을 나열합니다.
function listByService(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceGroupListByServiceOptionalParams): PagedAsyncIterableIterator<GroupContract, GroupContract[], PageSettings>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- workspaceId
-
string
작업 영역 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
옵션 매개 변수입니다.
반환
update(string, string, string, string, string, GroupUpdateParameters, WorkspaceGroupUpdateOptionalParams)
식별자가 지정한 그룹의 세부 정보를 업데이트합니다.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, ifMatch: string, parameters: GroupUpdateParameters, options?: WorkspaceGroupUpdateOptionalParams): Promise<WorkspaceGroupUpdateResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- workspaceId
-
string
작업 영역 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- groupId
-
string
그룹 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- ifMatch
-
string
엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.
- parameters
- GroupUpdateParameters
매개 변수를 업데이트합니다.
옵션 매개 변수입니다.
반환
Promise<WorkspaceGroupUpdateResponse>