User interface
사용자를 나타내는 인터페이스입니다.
메서드
| create |
사용자를 만들거나 업데이트합니다. |
| delete(string, string, string, string, User |
특정 사용자를 삭제합니다. |
| generate |
지정된 사용자를 개발자 포털에 서명하기 위한 인증 토큰이 포함된 리디렉션 URL을 검색합니다. |
| get(string, string, string, User |
식별자가 지정한 사용자의 세부 정보를 가져옵니다. |
| get |
식별자가 지정한 사용자의 Etag(엔터티 상태) 버전을 가져옵니다. |
| get |
사용자에 대한 공유 액세스 권한 부여 토큰을 가져옵니다. |
| list |
지정된 서비스 인스턴스에 등록된 사용자의 컬렉션을 나열합니다. |
| update(string, string, string, string, User |
식별자가 지정한 사용자의 세부 정보를 업데이트합니다. |
메서드 세부 정보
createOrUpdate(string, string, string, UserCreateParameters, UserCreateOrUpdateOptionalParams)
사용자를 만들거나 업데이트합니다.
function createOrUpdate(resourceGroupName: string, serviceName: string, userId: string, parameters: UserCreateParameters, options?: UserCreateOrUpdateOptionalParams): Promise<UserCreateOrUpdateResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- userId
-
string
사용자 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- parameters
- UserCreateParameters
매개 변수를 만들거나 업데이트합니다.
- options
- UserCreateOrUpdateOptionalParams
옵션 매개 변수입니다.
반환
Promise<UserCreateOrUpdateResponse>
delete(string, string, string, string, UserDeleteOptionalParams)
특정 사용자를 삭제합니다.
function delete(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, options?: UserDeleteOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- userId
-
string
사용자 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- ifMatch
-
string
엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.
- options
- UserDeleteOptionalParams
옵션 매개 변수입니다.
반환
Promise<void>
generateSsoUrl(string, string, string, UserGenerateSsoUrlOptionalParams)
지정된 사용자를 개발자 포털에 서명하기 위한 인증 토큰이 포함된 리디렉션 URL을 검색합니다.
function generateSsoUrl(resourceGroupName: string, serviceName: string, userId: string, options?: UserGenerateSsoUrlOptionalParams): Promise<GenerateSsoUrlResult>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- userId
-
string
사용자 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- options
- UserGenerateSsoUrlOptionalParams
옵션 매개 변수입니다.
반환
Promise<GenerateSsoUrlResult>
get(string, string, string, UserGetOptionalParams)
식별자가 지정한 사용자의 세부 정보를 가져옵니다.
function get(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetOptionalParams): Promise<UserGetResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- userId
-
string
사용자 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- options
- UserGetOptionalParams
옵션 매개 변수입니다.
반환
Promise<UserGetResponse>
getEntityTag(string, string, string, UserGetEntityTagOptionalParams)
식별자가 지정한 사용자의 Etag(엔터티 상태) 버전을 가져옵니다.
function getEntityTag(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetEntityTagOptionalParams): Promise<UserGetEntityTagHeaders>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- userId
-
string
사용자 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- options
- UserGetEntityTagOptionalParams
옵션 매개 변수입니다.
반환
Promise<UserGetEntityTagHeaders>
getSharedAccessToken(string, string, string, UserTokenParameters, UserGetSharedAccessTokenOptionalParams)
사용자에 대한 공유 액세스 권한 부여 토큰을 가져옵니다.
function getSharedAccessToken(resourceGroupName: string, serviceName: string, userId: string, parameters: UserTokenParameters, options?: UserGetSharedAccessTokenOptionalParams): Promise<UserTokenResult>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- userId
-
string
사용자 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- parameters
- UserTokenParameters
권한 부여 토큰 매개 변수를 만듭니다.
옵션 매개 변수입니다.
반환
Promise<UserTokenResult>
listByService(string, string, UserListByServiceOptionalParams)
지정된 서비스 인스턴스에 등록된 사용자의 컬렉션을 나열합니다.
function listByService(resourceGroupName: string, serviceName: string, options?: UserListByServiceOptionalParams): PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- options
- UserListByServiceOptionalParams
옵션 매개 변수입니다.
반환
update(string, string, string, string, UserUpdateParameters, UserUpdateOptionalParams)
식별자가 지정한 사용자의 세부 정보를 업데이트합니다.
function update(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, parameters: UserUpdateParameters, options?: UserUpdateOptionalParams): Promise<UserUpdateResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- userId
-
string
사용자 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- ifMatch
-
string
엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.
- parameters
- UserUpdateParameters
매개 변수를 업데이트합니다.
- options
- UserUpdateOptionalParams
옵션 매개 변수입니다.
반환
Promise<UserUpdateResponse>