ApiTagDescription interface
Interface représentant un ApiTagDescription.
Méthodes
| create |
Crée/met à jour une description de balise dans la portée de l’API. |
| delete(string, string, string, string, string, Api |
Supprimer la description de balise pour l’API. |
| get(string, string, string, string, Api |
Obtenir la description de la balise dans l’étendue de l’API |
| get |
Obtient la version d’état de l’entité de la balise spécifiée par son identificateur. |
| list |
Répertorie toutes les descriptions de balises dans la portée de l’API. Modèle similaire à swagger - tagDescription est défini au niveau de l’API, mais la balise peut être affectée aux opérations |
Détails de la méthode
createOrUpdate(string, string, string, string, TagDescriptionCreateParameters, ApiTagDescriptionCreateOrUpdateOptionalParams)
Crée/met à jour une description de balise dans la portée de l’API.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, parameters: TagDescriptionCreateParameters, options?: ApiTagDescriptionCreateOrUpdateOptionalParams): Promise<ApiTagDescriptionCreateOrUpdateResponse>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.
- tagDescriptionId
-
string
Identificateur de description de balise. Utilisé lors de la création de tagDescription pour api/association de balises. En fonction des noms d’API et de balise.
- parameters
- TagDescriptionCreateParameters
Créez des paramètres.
Paramètres d’options.
Retours
delete(string, string, string, string, string, ApiTagDescriptionDeleteOptionalParams)
Supprimer la description de balise pour l’API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, ifMatch: string, options?: ApiTagDescriptionDeleteOptionalParams): 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.
- tagDescriptionId
-
string
Identificateur de description de balise. Utilisé lors de la création de tagDescription pour api/association de balises. En fonction des noms d’API et de balise.
- 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.
Paramètres d’options.
Retours
Promise<void>
get(string, string, string, string, ApiTagDescriptionGetOptionalParams)
Obtenir la description de la balise dans l’étendue de l’API
function get(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, options?: ApiTagDescriptionGetOptionalParams): Promise<ApiTagDescriptionGetResponse>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.
- tagDescriptionId
-
string
Identificateur de description de balise. Utilisé lors de la création de tagDescription pour api/association de balises. En fonction des noms d’API et de balise.
Paramètres d’options.
Retours
Promise<ApiTagDescriptionGetResponse>
getEntityTag(string, string, string, string, ApiTagDescriptionGetEntityTagOptionalParams)
Obtient la version d’état de l’entité de la balise spécifiée par son identificateur.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, options?: ApiTagDescriptionGetEntityTagOptionalParams): Promise<ApiTagDescriptionGetEntityTagHeaders>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.
- tagDescriptionId
-
string
Identificateur de description de balise. Utilisé lors de la création de tagDescription pour api/association de balises. En fonction des noms d’API et de balise.
Paramètres d’options.
Retours
Promise<ApiTagDescriptionGetEntityTagHeaders>
listByService(string, string, string, ApiTagDescriptionListByServiceOptionalParams)
Répertorie toutes les descriptions de balises dans la portée de l’API. Modèle similaire à swagger - tagDescription est défini au niveau de l’API, mais la balise peut être affectée aux opérations
function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiTagDescriptionListByServiceOptionalParams): PagedAsyncIterableIterator<TagDescriptionContract, TagDescriptionContract[], 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.
Paramètres d’options.