Product interface
Interface représentant un produit.
Méthodes
| create |
Crée ou met à jour un produit. |
| delete(string, string, string, string, Product |
Supprime un produit. |
| get(string, string, string, Product |
Obtient les détails du produit spécifié par son identificateur. |
| get |
Obtient la version d’état d’entité (Etag) du produit spécifié par son identificateur. |
| list |
Répertorie un ensemble de produits dans l’instance de service spécifiée. |
| list |
Répertorie un ensemble de produits associés à des balises. |
| update(string, string, string, string, Product |
Mettre à jour les détails du produit existant. |
Détails de la méthode
createOrUpdate(string, string, string, ProductContract, ProductCreateOrUpdateOptionalParams)
Crée ou met à jour un produit.
function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, parameters: ProductContract, options?: ProductCreateOrUpdateOptionalParams): Promise<ProductCreateOrUpdateResponse>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 le instance de service Gestion des API actuel.
- parameters
- ProductContract
Créer ou mettre à jour des paramètres.
Paramètres d’options.
Retours
Promise<ProductCreateOrUpdateResponse>
delete(string, string, string, string, ProductDeleteOptionalParams)
Supprime un produit.
function delete(resourceGroupName: string, serviceName: string, productId: string, ifMatch: string, options?: ProductDeleteOptionalParams): 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 le instance de service Gestion des API actuel.
- ifMatch
-
string
ETag de l’entité. ETag doit correspondre à l’état d’entité actuel de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.
- options
- ProductDeleteOptionalParams
Paramètres d’options.
Retours
Promise<void>
get(string, string, string, ProductGetOptionalParams)
Obtient les détails du produit spécifié par son identificateur.
function get(resourceGroupName: string, serviceName: string, productId: string, options?: ProductGetOptionalParams): Promise<ProductGetResponse>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 le instance de service Gestion des API actuel.
- options
- ProductGetOptionalParams
Paramètres d’options.
Retours
Promise<ProductGetResponse>
getEntityTag(string, string, string, ProductGetEntityTagOptionalParams)
Obtient la version d’état d’entité (Etag) du produit spécifié par son identificateur.
function getEntityTag(resourceGroupName: string, serviceName: string, productId: string, options?: ProductGetEntityTagOptionalParams): Promise<ProductGetEntityTagHeaders>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 le instance de service Gestion des API actuel.
Paramètres d’options.
Retours
Promise<ProductGetEntityTagHeaders>
listByService(string, string, ProductListByServiceOptionalParams)
Répertorie un ensemble de produits dans l’instance de service spécifiée.
function listByService(resourceGroupName: string, serviceName: string, options?: ProductListByServiceOptionalParams): PagedAsyncIterableIterator<ProductContract, ProductContract[], 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.
Paramètres d’options.
Retours
listByTags(string, string, ProductListByTagsOptionalParams)
Répertorie un ensemble de produits associés à des balises.
function listByTags(resourceGroupName: string, serviceName: string, options?: ProductListByTagsOptionalParams): PagedAsyncIterableIterator<TagResourceContract, TagResourceContract[], 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.
- options
- ProductListByTagsOptionalParams
Paramètres d’options.
Retours
update(string, string, string, string, ProductUpdateParameters, ProductUpdateOptionalParams)
Mettre à jour les détails du produit existant.
function update(resourceGroupName: string, serviceName: string, productId: string, ifMatch: string, parameters: ProductUpdateParameters, options?: ProductUpdateOptionalParams): Promise<ProductUpdateResponse>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 le instance de service Gestion des API actuel.
- ifMatch
-
string
ETag de l’entité. ETag doit correspondre à l’état d’entité actuel de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.
- parameters
- ProductUpdateParameters
Mettre à jour les paramètres.
- options
- ProductUpdateOptionalParams
Paramètres d’options.
Retours
Promise<ProductUpdateResponse>