ProductApi interface
Interface représentant un ProductApi.
Méthodes
| check |
Vérifie que l’entité API spécifiée par l’identificateur est associée à l’entité Product. |
| create |
Ajoute une API au produit spécifié. |
| delete(string, string, string, string, Product |
Supprime l’API spécifiée du produit spécifié. |
| list |
Répertorie une collection des API associées à un produit. |
Détails de la méthode
checkEntityExists(string, string, string, string, ProductApiCheckEntityExistsOptionalParams)
Vérifie que l’entité API spécifiée par l’identificateur est associée à l’entité Product.
function checkEntityExists(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCheckEntityExistsOptionalParams): Promise<ProductApiCheckEntityExistsResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- productId
-
string
Identificateur de produit. Doit être unique dans l’instance actuelle du service Gestion des API.
- apiId
-
string
Identificateur de révision d’API. Doit être unique dans l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.
Paramètres d’options.
Retours
Promise<ProductApiCheckEntityExistsResponse>
createOrUpdate(string, string, string, string, ProductApiCreateOrUpdateOptionalParams)
Ajoute une API au produit spécifié.
function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCreateOrUpdateOptionalParams): Promise<ApiContract>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- productId
-
string
Identificateur de produit. Doit être unique dans l’instance actuelle du service Gestion des API.
- apiId
-
string
Identificateur de révision d’API. Doit être unique dans l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.
Paramètres d’options.
Retours
Promise<ApiContract>
delete(string, string, string, string, ProductApiDeleteOptionalParams)
Supprime l’API spécifiée du produit spécifié.
function delete(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiDeleteOptionalParams): Promise<void>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- productId
-
string
Identificateur de produit. Doit être unique dans l’instance actuelle du service Gestion des API.
- apiId
-
string
Identificateur de révision d’API. Doit être unique dans l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.
- options
- ProductApiDeleteOptionalParams
Paramètres d’options.
Retours
Promise<void>
listByProduct(string, string, string, ProductApiListByProductOptionalParams)
Répertorie une collection des API associées à un produit.
function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: ProductApiListByProductOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- productId
-
string
Identificateur de produit. Doit être unique dans l’instance actuelle du service Gestion des API.
Paramètres d’options.