GroupUser interface
GroupUser를 나타내는 인터페이스입니다.
메서드
| check |
식별자가 지정한 사용자 엔터티가 그룹 엔터티와 연결되어 있는지 확인합니다. |
| create(string, string, string, string, Group |
기존 그룹에 기존 사용자를 추가합니다. |
| delete(string, string, string, string, Group |
기존 그룹에서 기존 사용자를 제거합니다. |
| list(string, string, string, Group |
그룹에 연결된 사용자 엔터티의 컬렉션을 나열합니다. |
메서드 세부 정보
checkEntityExists(string, string, string, string, GroupUserCheckEntityExistsOptionalParams)
식별자가 지정한 사용자 엔터티가 그룹 엔터티와 연결되어 있는지 확인합니다.
function checkEntityExists(resourceGroupName: string, serviceName: string, groupId: string, userId: string, options?: GroupUserCheckEntityExistsOptionalParams): Promise<GroupUserCheckEntityExistsResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- groupId
-
string
그룹 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- userId
-
string
사용자 식별자 현재 API Management 서비스 instance 고유해야 합니다.
옵션 매개 변수입니다.
반환
Promise<GroupUserCheckEntityExistsResponse>
create(string, string, string, string, GroupUserCreateOptionalParams)
기존 그룹에 기존 사용자를 추가합니다.
function create(resourceGroupName: string, serviceName: string, groupId: string, userId: string, options?: GroupUserCreateOptionalParams): Promise<UserContract>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- groupId
-
string
그룹 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- userId
-
string
사용자 식별자 현재 API Management 서비스 instance 고유해야 합니다.
- options
- GroupUserCreateOptionalParams
옵션 매개 변수입니다.
반환
Promise<UserContract>
delete(string, string, string, string, GroupUserDeleteOptionalParams)
기존 그룹에서 기존 사용자를 제거합니다.
function delete(resourceGroupName: string, serviceName: string, groupId: string, userId: string, options?: GroupUserDeleteOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- groupId
-
string
그룹 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- userId
-
string
사용자 식별자 현재 API Management 서비스 instance 고유해야 합니다.
- options
- GroupUserDeleteOptionalParams
옵션 매개 변수입니다.
반환
Promise<void>
list(string, string, string, GroupUserListOptionalParams)
그룹에 연결된 사용자 엔터티의 컬렉션을 나열합니다.
function list(resourceGroupName: string, serviceName: string, groupId: string, options?: GroupUserListOptionalParams): PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- groupId
-
string
그룹 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- options
- GroupUserListOptionalParams
옵션 매개 변수입니다.