Gateway interface
게이트웨이를 나타내는 인터페이스입니다.
메서드
메서드 세부 정보
createOrUpdate(string, string, string, GatewayContract, GatewayCreateOrUpdateOptionalParams)
Api Management instance 사용할 게이트웨이를 만들거나 업데이트합니다.
function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayContract, options?: GatewayCreateOrUpdateOptionalParams): Promise<GatewayCreateOrUpdateResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- gatewayId
-
string
게이트웨이 엔터티 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 'managed' 값이 없어야 합니다.
- parameters
- GatewayContract
게이트웨이 세부 정보입니다.
옵션 매개 변수입니다.
반환
Promise<GatewayCreateOrUpdateResponse>
delete(string, string, string, string, GatewayDeleteOptionalParams)
특정 게이트웨이를 삭제합니다.
function delete(resourceGroupName: string, serviceName: string, gatewayId: string, ifMatch: string, options?: GatewayDeleteOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- gatewayId
-
string
게이트웨이 엔터티 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 'managed' 값이 없어야 합니다.
- ifMatch
-
string
엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.
- options
- GatewayDeleteOptionalParams
옵션 매개 변수입니다.
반환
Promise<void>
generateToken(string, string, string, GatewayTokenRequestContract, GatewayGenerateTokenOptionalParams)
게이트웨이에 대한 공유 액세스 권한 부여 토큰을 가져옵니다.
function generateToken(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayTokenRequestContract, options?: GatewayGenerateTokenOptionalParams): Promise<GatewayTokenContract>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- gatewayId
-
string
게이트웨이 엔터티 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 'managed' 값이 없어야 합니다.
- parameters
- GatewayTokenRequestContract
게이트웨이 토큰 요청 계약 속성입니다.
옵션 매개 변수입니다.
반환
Promise<GatewayTokenContract>
get(string, string, string, GatewayGetOptionalParams)
식별자가 지정한 게이트웨이의 세부 정보를 가져옵니다.
function get(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetOptionalParams): Promise<GatewayGetResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- gatewayId
-
string
게이트웨이 엔터티 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 'managed' 값이 없어야 합니다.
- options
- GatewayGetOptionalParams
옵션 매개 변수입니다.
반환
Promise<GatewayGetResponse>
getEntityTag(string, string, string, GatewayGetEntityTagOptionalParams)
식별자가 지정한 게이트웨이의 엔터티 상태(Etag) 버전을 가져옵니다.
function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetEntityTagOptionalParams): Promise<GatewayGetEntityTagHeaders>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- gatewayId
-
string
게이트웨이 엔터티 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 'managed' 값이 없어야 합니다.
옵션 매개 변수입니다.
반환
Promise<GatewayGetEntityTagHeaders>
listByService(string, string, GatewayListByServiceOptionalParams)
서비스 인스턴스에 등록된 게이트웨이의 컬렉션을 나열합니다.
function listByService(resourceGroupName: string, serviceName: string, options?: GatewayListByServiceOptionalParams): PagedAsyncIterableIterator<GatewayContract, GatewayContract[], PageSettings>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
옵션 매개 변수입니다.
반환
listKeys(string, string, string, GatewayListKeysOptionalParams)
게이트웨이 키를 검색합니다.
function listKeys(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayListKeysOptionalParams): Promise<GatewayListKeysResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- gatewayId
-
string
게이트웨이 엔터티 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 'managed' 값이 없어야 합니다.
- options
- GatewayListKeysOptionalParams
옵션 매개 변수입니다.
반환
Promise<GatewayListKeysResponse>
regenerateKey(string, string, string, GatewayKeyRegenerationRequestContract, GatewayRegenerateKeyOptionalParams)
지정된 게이트웨이 키를 다시 생성하여 생성된 토큰을 무효화합니다.
function regenerateKey(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayKeyRegenerationRequestContract, options?: GatewayRegenerateKeyOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- gatewayId
-
string
게이트웨이 엔터티 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 'managed' 값이 없어야 합니다.
- parameters
- GatewayKeyRegenerationRequestContract
게이트웨이 키 다시 생성 요청 계약 속성입니다.
옵션 매개 변수입니다.
반환
Promise<void>
update(string, string, string, string, GatewayContract, GatewayUpdateOptionalParams)
식별자가 지정한 게이트웨이의 세부 정보를 업데이트.
function update(resourceGroupName: string, serviceName: string, gatewayId: string, ifMatch: string, parameters: GatewayContract, options?: GatewayUpdateOptionalParams): Promise<GatewayUpdateResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- gatewayId
-
string
게이트웨이 엔터티 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. 'managed' 값이 없어야 합니다.
- ifMatch
-
string
엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.
- parameters
- GatewayContract
게이트웨이 세부 정보입니다.
- options
- GatewayUpdateOptionalParams
옵션 매개 변수입니다.
반환
Promise<GatewayUpdateResponse>