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