Tag interface
Interface représentant une balise.
Méthodes
Détails de la méthode
assignToApi(string, string, string, string, TagAssignToApiOptionalParams)
Assigne une balise à l’API.
function assignToApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagAssignToApiOptionalParams): Promise<TagAssignToApiResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- apiId
-
string
Identificateur de révision d’API. Doit être unique dans le instance de service Gestion des API actuel. La révision non actuelle a ;rev=n comme suffixe où n est le numéro de révision.
- tagId
-
string
Identificateur de balise. Doit être unique dans le instance de service Gestion des API actuel.
- options
- TagAssignToApiOptionalParams
Paramètres d’options.
Retours
Promise<TagAssignToApiResponse>
assignToOperation(string, string, string, string, string, TagAssignToOperationOptionalParams)
Affectez la balise à l’opération.
function assignToOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagAssignToOperationOptionalParams): Promise<TagContract>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- apiId
-
string
Identificateur de révision d’API. Doit être unique dans le instance de service Gestion des API actuel. La révision non actuelle a ;rev=n comme suffixe où n est le numéro de révision.
- operationId
-
string
Identificateur d’opération au sein d’une API. Doit être unique dans le instance de service Gestion des API actuel.
- tagId
-
string
Identificateur de balise. Doit être unique dans le instance de service Gestion des API actuel.
Paramètres d’options.
Retours
Promise<TagContract>
assignToProduct(string, string, string, string, TagAssignToProductOptionalParams)
Assigne une balise au produit.
function assignToProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagAssignToProductOptionalParams): Promise<TagContract>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.
- tagId
-
string
Identificateur de balise. Doit être unique dans le instance de service Gestion des API actuel.
- options
- TagAssignToProductOptionalParams
Paramètres d’options.
Retours
Promise<TagContract>
createOrUpdate(string, string, string, TagCreateUpdateParameters, TagCreateOrUpdateOptionalParams)
Crée une balise.
function createOrUpdate(resourceGroupName: string, serviceName: string, tagId: string, parameters: TagCreateUpdateParameters, options?: TagCreateOrUpdateOptionalParams): Promise<TagCreateOrUpdateResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- tagId
-
string
Identificateur de balise. Doit être unique dans le instance de service Gestion des API actuel.
- parameters
- TagCreateUpdateParameters
Créez des paramètres.
- options
- TagCreateOrUpdateOptionalParams
Paramètres d’options.
Retours
Promise<TagCreateOrUpdateResponse>
delete(string, string, string, string, TagDeleteOptionalParams)
Supprime une balise spécifique de l’instance de service de gestion des API.
function delete(resourceGroupName: string, serviceName: string, tagId: string, ifMatch: string, options?: TagDeleteOptionalParams): 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.
- tagId
-
string
Identificateur de balise. 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
- TagDeleteOptionalParams
Paramètres d’options.
Retours
Promise<void>
detachFromApi(string, string, string, string, TagDetachFromApiOptionalParams)
Détache la balise de l’API.
function detachFromApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagDetachFromApiOptionalParams): 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.
- apiId
-
string
Identificateur de révision d’API. Doit être unique dans le instance de service Gestion des API actuel. La révision non actuelle a ;rev=n comme suffixe où n est le numéro de révision.
- tagId
-
string
Identificateur de balise. Doit être unique dans le instance de service Gestion des API actuel.
- options
- TagDetachFromApiOptionalParams
Paramètres d’options.
Retours
Promise<void>
detachFromOperation(string, string, string, string, string, TagDetachFromOperationOptionalParams)
Détacher la balise de l’opération.
function detachFromOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagDetachFromOperationOptionalParams): 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.
- apiId
-
string
Identificateur de révision d’API. Doit être unique dans le instance de service Gestion des API actuel. La révision non actuelle a ;rev=n comme suffixe où n est le numéro de révision.
- operationId
-
string
Identificateur d’opération au sein d’une API. Doit être unique dans le instance de service Gestion des API actuel.
- tagId
-
string
Identificateur de balise. Doit être unique dans le instance de service Gestion des API actuel.
Paramètres d’options.
Retours
Promise<void>
detachFromProduct(string, string, string, string, TagDetachFromProductOptionalParams)
Détache la balise du produit.
function detachFromProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagDetachFromProductOptionalParams): 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.
- tagId
-
string
Identificateur de balise. Doit être unique dans le instance de service Gestion des API actuel.
Paramètres d’options.
Retours
Promise<void>
get(string, string, string, TagGetOptionalParams)
Obtient les détails de la balise spécifiée par son identificateur.
function get(resourceGroupName: string, serviceName: string, tagId: string, options?: TagGetOptionalParams): Promise<TagGetResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- tagId
-
string
Identificateur de balise. Doit être unique dans le instance de service Gestion des API actuel.
- options
- TagGetOptionalParams
Paramètres d’options.
Retours
Promise<TagGetResponse>
getByApi(string, string, string, string, TagGetByApiOptionalParams)
Obtenir la balise associée à l’API.
function getByApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagGetByApiOptionalParams): Promise<TagGetByApiResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- apiId
-
string
Identificateur de révision d’API. Doit être unique dans le instance de service Gestion des API actuel. La révision non actuelle a ;rev=n comme suffixe où n est le numéro de révision.
- tagId
-
string
Identificateur de balise. Doit être unique dans le instance de service Gestion des API actuel.
- options
- TagGetByApiOptionalParams
Paramètres d’options.
Retours
Promise<TagGetByApiResponse>
getByOperation(string, string, string, string, string, TagGetByOperationOptionalParams)
Obtenir la balise associée à l’opération.
function getByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagGetByOperationOptionalParams): Promise<TagGetByOperationResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- apiId
-
string
Identificateur de révision d’API. Doit être unique dans le instance de service Gestion des API actuel. La révision non actuelle a ;rev=n comme suffixe où n est le numéro de révision.
- operationId
-
string
Identificateur d’opération au sein d’une API. Doit être unique dans le instance de service Gestion des API actuel.
- tagId
-
string
Identificateur de balise. Doit être unique dans le instance de service Gestion des API actuel.
- options
- TagGetByOperationOptionalParams
Paramètres d’options.
Retours
Promise<TagGetByOperationResponse>
getByProduct(string, string, string, string, TagGetByProductOptionalParams)
Obtenir la balise associée au produit.
function getByProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagGetByProductOptionalParams): Promise<TagGetByProductResponse>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.
- tagId
-
string
Identificateur de balise. Doit être unique dans le instance de service Gestion des API actuel.
- options
- TagGetByProductOptionalParams
Paramètres d’options.
Retours
Promise<TagGetByProductResponse>
getEntityState(string, string, string, TagGetEntityStateOptionalParams)
Obtient la version d’état de l’entité de la balise spécifiée par son identificateur.
function getEntityState(resourceGroupName: string, serviceName: string, tagId: string, options?: TagGetEntityStateOptionalParams): Promise<TagGetEntityStateHeaders>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- tagId
-
string
Identificateur de balise. Doit être unique dans le instance de service Gestion des API actuel.
- options
- TagGetEntityStateOptionalParams
Paramètres d’options.
Retours
Promise<TagGetEntityStateHeaders>
getEntityStateByApi(string, string, string, string, TagGetEntityStateByApiOptionalParams)
Obtient la version d’état de l’entité de la balise spécifiée par son identificateur.
function getEntityStateByApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagGetEntityStateByApiOptionalParams): Promise<TagGetEntityStateByApiHeaders>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- apiId
-
string
Identificateur de révision d’API. Doit être unique dans le instance de service Gestion des API actuel. La révision non actuelle a ;rev=n comme suffixe où n est le numéro de révision.
- tagId
-
string
Identificateur de balise. Doit être unique dans le instance de service Gestion des API actuel.
Paramètres d’options.
Retours
Promise<TagGetEntityStateByApiHeaders>
getEntityStateByOperation(string, string, string, string, string, TagGetEntityStateByOperationOptionalParams)
Obtient la version d’état de l’entité de la balise spécifiée par son identificateur.
function getEntityStateByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagGetEntityStateByOperationOptionalParams): Promise<TagGetEntityStateByOperationHeaders>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- apiId
-
string
Identificateur de révision d’API. Doit être unique dans le instance de service Gestion des API actuel. La révision non actuelle a ;rev=n comme suffixe où n est le numéro de révision.
- operationId
-
string
Identificateur d’opération au sein d’une API. Doit être unique dans le instance de service Gestion des API actuel.
- tagId
-
string
Identificateur de balise. Doit être unique dans le instance de service Gestion des API actuel.
Paramètres d’options.
Retours
Promise<TagGetEntityStateByOperationHeaders>
getEntityStateByProduct(string, string, string, string, TagGetEntityStateByProductOptionalParams)
Obtient la version d’état de l’entité de la balise spécifiée par son identificateur.
function getEntityStateByProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagGetEntityStateByProductOptionalParams): Promise<TagGetEntityStateByProductHeaders>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.
- tagId
-
string
Identificateur de balise. Doit être unique dans le instance de service Gestion des API actuel.
Paramètres d’options.
Retours
Promise<TagGetEntityStateByProductHeaders>
listByApi(string, string, string, TagListByApiOptionalParams)
Répertorie toutes les balises associées à l’API.
function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: TagListByApiOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], 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.
- apiId
-
string
Identificateur de révision d’API. Doit être unique dans le instance de service Gestion des API actuel. La révision non actuelle a ;rev=n comme suffixe où n est le numéro de révision.
- options
- TagListByApiOptionalParams
Paramètres d’options.
Retours
listByOperation(string, string, string, string, TagListByOperationOptionalParams)
Répertorie toutes les balises associées à l’opération.
function listByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: TagListByOperationOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], 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.
- apiId
-
string
Identificateur de révision d’API. Doit être unique dans le instance de service Gestion des API actuel. La révision non actuelle a ;rev=n comme suffixe où n est le numéro de révision.
- operationId
-
string
Identificateur d’opération dans une API. Doit être unique dans le instance de service Gestion des API actuel.
- options
- TagListByOperationOptionalParams
Paramètres d’options.
Retours
listByProduct(string, string, string, TagListByProductOptionalParams)
Répertorie toutes les balises associées au produit.
function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: TagListByProductOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], 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 le instance de service Gestion des API actuel.
- options
- TagListByProductOptionalParams
Paramètres d’options.
Retours
listByService(string, string, TagListByServiceOptionalParams)
Répertorie une collection de balises définies dans une instance de service.
function listByService(resourceGroupName: string, serviceName: string, options?: TagListByServiceOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], 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
- TagListByServiceOptionalParams
Paramètres d’options.
Retours
update(string, string, string, string, TagCreateUpdateParameters, TagUpdateOptionalParams)
Mises à jour les détails de la balise spécifiée par son identificateur.
function update(resourceGroupName: string, serviceName: string, tagId: string, ifMatch: string, parameters: TagCreateUpdateParameters, options?: TagUpdateOptionalParams): Promise<TagUpdateResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- tagId
-
string
Identificateur de balise. Doit être unique dans le instance de service Gestion des API actuel.
- ifMatch
-
string
ETag de l’entité. ETag doit correspondre à l’état actuel de l’entité à partir de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.
- parameters
- TagCreateUpdateParameters
Mettre à jour les paramètres.
- options
- TagUpdateOptionalParams
Paramètres d’options.
Retours
Promise<TagUpdateResponse>