ProductApi interface
ProductApi-t képviselő felület.
Metódusok
| check |
Ellenőrzi, hogy az azonosító által megadott API-entitás társítva van-e a Termék entitással. |
| create |
Hozzáad egy API-t a megadott termékhez. |
| delete(string, string, string, string, Product |
Törli a megadott API-t a megadott termékből. |
| list |
A termékhez társított API-k gyűjteményét sorolja fel. |
Metódus adatai
checkEntityExists(string, string, string, string, ProductApiCheckEntityExistsOptionalParams)
Ellenőrzi, hogy az azonosító által megadott API-entitás társítva van-e a Termék entitással.
function checkEntityExists(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCheckEntityExistsOptionalParams): Promise<ProductApiCheckEntityExistsResponse>
Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- productId
-
string
Termékazonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.
- apiId
-
string
API-változat azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma.
A beállítások paraméterei.
Válaszok
Promise<ProductApiCheckEntityExistsResponse>
createOrUpdate(string, string, string, string, ProductApiCreateOrUpdateOptionalParams)
Hozzáad egy API-t a megadott termékhez.
function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCreateOrUpdateOptionalParams): Promise<ApiContract>
Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- productId
-
string
Termékazonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.
- apiId
-
string
API-változat azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma.
A beállítások paraméterei.
Válaszok
Promise<ApiContract>
delete(string, string, string, string, ProductApiDeleteOptionalParams)
Törli a megadott API-t a megadott termékből.
function delete(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiDeleteOptionalParams): Promise<void>
Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- productId
-
string
Termékazonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.
- apiId
-
string
API-változat azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma.
- options
- ProductApiDeleteOptionalParams
A beállítások paraméterei.
Válaszok
Promise<void>
listByProduct(string, string, string, ProductApiListByProductOptionalParams)
A termékhez társított API-k gyűjteményét sorolja fel.
function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: ProductApiListByProductOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>
Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- productId
-
string
Termékazonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.
A beállítások paraméterei.