WorkspaceProduct interface
WorkspaceProduct를 나타내는 인터페이스입니다.
메서드
| create |
제품을 만들거나 업데이트합니다. |
| delete(string, string, string, string, string, Workspace |
제품을 삭제합니다. |
| get(string, string, string, string, Workspace |
식별자가 지정한 제품의 세부 정보를 가져옵니다. |
| get |
식별자가 지정한 제품의 Etag(엔터티 상태) 버전을 가져옵니다. |
| list |
서비스 인스턴스의 지정된 작업 영역에 있는 제품 컬렉션을 나열합니다. |
| update(string, string, string, string, string, Product |
기존 제품 세부 정보를 업데이트합니다. |
메서드 세부 정보
createOrUpdate(string, string, string, string, ProductContract, WorkspaceProductCreateOrUpdateOptionalParams)
제품을 만들거나 업데이트합니다.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, productId: string, parameters: ProductContract, options?: WorkspaceProductCreateOrUpdateOptionalParams): Promise<WorkspaceProductCreateOrUpdateResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- workspaceId
-
string
작업 영역 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- productId
-
string
제품 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- parameters
- ProductContract
매개 변수를 만들거나 업데이트합니다.
옵션 매개 변수입니다.
반환
delete(string, string, string, string, string, WorkspaceProductDeleteOptionalParams)
제품을 삭제합니다.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, productId: string, ifMatch: string, options?: WorkspaceProductDeleteOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- workspaceId
-
string
작업 영역 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- productId
-
string
제품 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- ifMatch
-
string
엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.
옵션 매개 변수입니다.
반환
Promise<void>
get(string, string, string, string, WorkspaceProductGetOptionalParams)
식별자가 지정한 제품의 세부 정보를 가져옵니다.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, productId: string, options?: WorkspaceProductGetOptionalParams): Promise<WorkspaceProductGetResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- workspaceId
-
string
작업 영역 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- productId
-
string
제품 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
옵션 매개 변수입니다.
반환
Promise<WorkspaceProductGetResponse>
getEntityTag(string, string, string, string, WorkspaceProductGetEntityTagOptionalParams)
식별자가 지정한 제품의 Etag(엔터티 상태) 버전을 가져옵니다.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, productId: string, options?: WorkspaceProductGetEntityTagOptionalParams): Promise<WorkspaceProductGetEntityTagHeaders>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- workspaceId
-
string
작업 영역 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- productId
-
string
제품 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
옵션 매개 변수입니다.
반환
Promise<WorkspaceProductGetEntityTagHeaders>
listByService(string, string, string, WorkspaceProductListByServiceOptionalParams)
서비스 인스턴스의 지정된 작업 영역에 있는 제품 컬렉션을 나열합니다.
function listByService(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceProductListByServiceOptionalParams): PagedAsyncIterableIterator<ProductContract, ProductContract[], PageSettings>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- workspaceId
-
string
작업 영역 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
옵션 매개 변수입니다.
반환
update(string, string, string, string, string, ProductUpdateParameters, WorkspaceProductUpdateOptionalParams)
기존 제품 세부 정보를 업데이트합니다.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, productId: string, ifMatch: string, parameters: ProductUpdateParameters, options?: WorkspaceProductUpdateOptionalParams): Promise<WorkspaceProductUpdateResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- workspaceId
-
string
작업 영역 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- productId
-
string
제품 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- ifMatch
-
string
엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.
- parameters
- ProductUpdateParameters
매개 변수를 업데이트합니다.
옵션 매개 변수입니다.
반환
Promise<WorkspaceProductUpdateResponse>