Backend interface
백 엔드를 나타내는 인터페이스입니다.
메서드
| create |
백엔드를 만들거나 업데이트합니다. |
| delete(string, string, string, string, Backend |
지정된 백엔드를 삭제합니다. |
| get(string, string, string, Backend |
식별자가 지정한 백 엔드의 세부 정보를 가져옵니다. |
| get |
식별자가 지정한 백 엔드의 엔터티 상태(Etag) 버전을 가져옵니다. |
| list |
지정된 서비스 인스턴스의 백엔드 컬렉션을 나열합니다. |
| reconnect(string, string, string, Backend |
지정된 시간 제한 후에 백 엔드에 대한 새 연결을 만들도록 API Management 게이트웨이에 알 보냅니다. 시간 제한이 지정되지 않은 경우 2분의 시간 제한이 사용됩니다. |
| update(string, string, string, string, Backend |
기존 백 엔드를 업데이트. |
메서드 세부 정보
createOrUpdate(string, string, string, BackendContract, BackendCreateOrUpdateOptionalParams)
백엔드를 만들거나 업데이트합니다.
function createOrUpdate(resourceGroupName: string, serviceName: string, backendId: string, parameters: BackendContract, options?: BackendCreateOrUpdateOptionalParams): Promise<BackendCreateOrUpdateResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- backendId
-
string
백 엔드 엔터티의 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- parameters
- BackendContract
매개 변수를 만듭니다.
옵션 매개 변수입니다.
반환
Promise<BackendCreateOrUpdateResponse>
delete(string, string, string, string, BackendDeleteOptionalParams)
지정된 백엔드를 삭제합니다.
function delete(resourceGroupName: string, serviceName: string, backendId: string, ifMatch: string, options?: BackendDeleteOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- backendId
-
string
백 엔드 엔터티의 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- ifMatch
-
string
엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.
- options
- BackendDeleteOptionalParams
옵션 매개 변수입니다.
반환
Promise<void>
get(string, string, string, BackendGetOptionalParams)
식별자가 지정한 백 엔드의 세부 정보를 가져옵니다.
function get(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendGetOptionalParams): Promise<BackendGetResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- backendId
-
string
백 엔드 엔터티의 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- options
- BackendGetOptionalParams
옵션 매개 변수입니다.
반환
Promise<BackendGetResponse>
getEntityTag(string, string, string, BackendGetEntityTagOptionalParams)
식별자가 지정한 백 엔드의 엔터티 상태(Etag) 버전을 가져옵니다.
function getEntityTag(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendGetEntityTagOptionalParams): Promise<BackendGetEntityTagHeaders>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- backendId
-
string
백 엔드 엔터티의 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
옵션 매개 변수입니다.
반환
Promise<BackendGetEntityTagHeaders>
listByService(string, string, BackendListByServiceOptionalParams)
지정된 서비스 인스턴스의 백엔드 컬렉션을 나열합니다.
function listByService(resourceGroupName: string, serviceName: string, options?: BackendListByServiceOptionalParams): PagedAsyncIterableIterator<BackendContract, BackendContract[], PageSettings>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
옵션 매개 변수입니다.
반환
reconnect(string, string, string, BackendReconnectOptionalParams)
지정된 시간 제한 후에 백 엔드에 대한 새 연결을 만들도록 API Management 게이트웨이에 알 보냅니다. 시간 제한이 지정되지 않은 경우 2분의 시간 제한이 사용됩니다.
function reconnect(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendReconnectOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- backendId
-
string
백 엔드 엔터티의 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- options
- BackendReconnectOptionalParams
옵션 매개 변수입니다.
반환
Promise<void>
update(string, string, string, string, BackendUpdateParameters, BackendUpdateOptionalParams)
기존 백 엔드를 업데이트.
function update(resourceGroupName: string, serviceName: string, backendId: string, ifMatch: string, parameters: BackendUpdateParameters, options?: BackendUpdateOptionalParams): Promise<BackendUpdateResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- backendId
-
string
백 엔드 엔터티의 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
- ifMatch
-
string
엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.
- parameters
- BackendUpdateParameters
매개 변수를 업데이트합니다.
- options
- BackendUpdateOptionalParams
옵션 매개 변수입니다.
반환
Promise<BackendUpdateResponse>