ProductApi interface
Gränssnitt som representerar en ProductApi.
Metoder
| check |
Kontrollerar att API-entiteten som anges av identifieraren är associerad med entiteten Produkt. |
| create |
Lägger till ett API i den angivna produkten. |
| delete(string, string, string, string, Product |
Tar bort det angivna API:et från den angivna produkten. |
| list |
Visar en samling api:er som är associerade med en produkt. |
Metodinformation
checkEntityExists(string, string, string, string, ProductApiCheckEntityExistsOptionalParams)
Kontrollerar att API-entiteten som anges av identifieraren är associerad med entiteten Produkt.
function checkEntityExists(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCheckEntityExistsOptionalParams): Promise<ProductApiCheckEntityExistsResponse>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- productId
-
string
Produktidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.
- apiId
-
string
API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ;rev=n som suffix där n är revisionsnumret.
Alternativparametrarna.
Returer
Promise<ProductApiCheckEntityExistsResponse>
createOrUpdate(string, string, string, string, ProductApiCreateOrUpdateOptionalParams)
Lägger till ett API i den angivna produkten.
function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCreateOrUpdateOptionalParams): Promise<ApiContract>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- productId
-
string
Produktidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.
- apiId
-
string
API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ;rev=n som suffix där n är revisionsnumret.
Alternativparametrarna.
Returer
Promise<ApiContract>
delete(string, string, string, string, ProductApiDeleteOptionalParams)
Tar bort det angivna API:et från den angivna produkten.
function delete(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiDeleteOptionalParams): Promise<void>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- productId
-
string
Produktidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.
- apiId
-
string
API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ;rev=n som suffix där n är revisionsnumret.
- options
- ProductApiDeleteOptionalParams
Alternativparametrarna.
Returer
Promise<void>
listByProduct(string, string, string, ProductApiListByProductOptionalParams)
Visar en samling api:er som är associerade med en produkt.
function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: ProductApiListByProductOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- productId
-
string
Produktidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.
Alternativparametrarna.