WorkspaceBackend interface
WorkspaceBackend를 나타내는 인터페이스입니다.
메서드
| create |
백엔드를 만들거나 업데이트합니다. |
| delete(string, string, string, string, string, Workspace |
지정된 백엔드를 삭제합니다. |
| get(string, string, string, string, Workspace |
식별자가 지정한 백 엔드의 세부 정보를 가져옵니다. |
| get |
식별자가 지정한 백 엔드의 엔터티 상태(Etag) 버전을 가져옵니다. |
| list |
지정된 작업 영역의 백 엔드 컬렉션을 나열합니다. |
| update(string, string, string, string, string, Backend |
기존 백 엔드를 업데이트합니다. |
메서드 세부 정보
createOrUpdate(string, string, string, string, BackendContract, WorkspaceBackendCreateOrUpdateOptionalParams)
백엔드를 만들거나 업데이트합니다.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, backendId: string, parameters: BackendContract, options?: WorkspaceBackendCreateOrUpdateOptionalParams): Promise<WorkspaceBackendCreateOrUpdateResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- workspaceId
-
string
작업 영역 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- backendId
-
string
백 엔드 엔터티의 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- parameters
- BackendContract
매개 변수를 만듭니다.
옵션 매개 변수입니다.
반환
delete(string, string, string, string, string, WorkspaceBackendDeleteOptionalParams)
지정된 백엔드를 삭제합니다.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, backendId: string, ifMatch: string, options?: WorkspaceBackendDeleteOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- workspaceId
-
string
작업 영역 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- backendId
-
string
백 엔드 엔터티의 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- ifMatch
-
string
엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.
옵션 매개 변수입니다.
반환
Promise<void>
get(string, string, string, string, WorkspaceBackendGetOptionalParams)
식별자가 지정한 백 엔드의 세부 정보를 가져옵니다.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, backendId: string, options?: WorkspaceBackendGetOptionalParams): Promise<WorkspaceBackendGetResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- workspaceId
-
string
작업 영역 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- backendId
-
string
백 엔드 엔터티의 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
옵션 매개 변수입니다.
반환
Promise<WorkspaceBackendGetResponse>
getEntityTag(string, string, string, string, WorkspaceBackendGetEntityTagOptionalParams)
식별자가 지정한 백 엔드의 엔터티 상태(Etag) 버전을 가져옵니다.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, backendId: string, options?: WorkspaceBackendGetEntityTagOptionalParams): Promise<WorkspaceBackendGetEntityTagHeaders>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- workspaceId
-
string
작업 영역 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- backendId
-
string
백 엔드 엔터티의 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
옵션 매개 변수입니다.
반환
Promise<WorkspaceBackendGetEntityTagHeaders>
listByWorkspace(string, string, string, WorkspaceBackendListByWorkspaceOptionalParams)
지정된 작업 영역의 백 엔드 컬렉션을 나열합니다.
function listByWorkspace(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceBackendListByWorkspaceOptionalParams): PagedAsyncIterableIterator<BackendContract, BackendContract[], PageSettings>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- workspaceId
-
string
작업 영역 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
옵션 매개 변수입니다.
반환
update(string, string, string, string, string, BackendUpdateParameters, WorkspaceBackendUpdateOptionalParams)
기존 백 엔드를 업데이트합니다.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, backendId: string, ifMatch: string, parameters: BackendUpdateParameters, options?: WorkspaceBackendUpdateOptionalParams): Promise<WorkspaceBackendUpdateResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- workspaceId
-
string
작업 영역 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- backendId
-
string
백 엔드 엔터티의 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- ifMatch
-
string
엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.
- parameters
- BackendUpdateParameters
매개 변수를 업데이트합니다.
옵션 매개 변수입니다.
반환
Promise<WorkspaceBackendUpdateResponse>