ProductApi interface
ProductApi를 나타내는 인터페이스입니다.
메서드
| check |
식별자가 지정한 API 엔터티가 Product 엔터티와 연결되어 있는지 확인합니다. |
| create |
지정된 제품에 API를 추가합니다. |
| delete(string, string, string, string, Product |
지정된 제품에서 지정된 API를 삭제합니다. |
| list |
제품과 연결된 API 컬렉션을 나열합니다. |
메서드 세부 정보
checkEntityExists(string, string, string, string, ProductApiCheckEntityExistsOptionalParams)
식별자가 지정한 API 엔터티가 Product 엔터티와 연결되어 있는지 확인합니다.
function checkEntityExists(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCheckEntityExistsOptionalParams): Promise<ProductApiCheckEntityExistsResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- productId
-
string
제품 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- apiId
-
string
API 수정 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 다음이 있습니다. rev=n은 접미사로, n은 수정 번호입니다.
옵션 매개 변수입니다.
반환
Promise<ProductApiCheckEntityExistsResponse>
createOrUpdate(string, string, string, string, ProductApiCreateOrUpdateOptionalParams)
지정된 제품에 API를 추가합니다.
function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCreateOrUpdateOptionalParams): Promise<ApiContract>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- productId
-
string
제품 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- apiId
-
string
API 수정 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 다음이 있습니다. rev=n은 접미사로, n은 수정 번호입니다.
옵션 매개 변수입니다.
반환
Promise<ApiContract>
delete(string, string, string, string, ProductApiDeleteOptionalParams)
지정된 제품에서 지정된 API를 삭제합니다.
function delete(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiDeleteOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- productId
-
string
제품 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
- apiId
-
string
API 수정 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다. 현재 버전이 아닌 수정 버전에는 다음이 있습니다. rev=n은 접미사로, n은 수정 번호입니다.
- options
- ProductApiDeleteOptionalParams
옵션 매개 변수입니다.
반환
Promise<void>
listByProduct(string, string, string, ProductApiListByProductOptionalParams)
제품과 연결된 API 컬렉션을 나열합니다.
function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: ProductApiListByProductOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
- serviceName
-
string
API Management 서비스의 이름입니다.
- productId
-
string
제품 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
옵션 매개 변수입니다.