Partager via


ApiContract Classe

Définition

Détails de l’API.

[Microsoft.Rest.Serialization.JsonTransformation]
public class ApiContract : Microsoft.Azure.Management.ApiManagement.Models.Resource
[<Microsoft.Rest.Serialization.JsonTransformation>]
type ApiContract = class
    inherit Resource
Public Class ApiContract
Inherits Resource
Héritage
ApiContract
Attributs

Constructeurs

ApiContract()

Initialise une nouvelle instance de la classe ApiContract.

ApiContract(String, String, String, String, String, AuthenticationSettingsContract, SubscriptionKeyParameterNamesContract, String, String, String, Nullable<Boolean>, Nullable<Boolean>, String, String, String, Nullable<Boolean>, String, ApiContactInformation, ApiLicenseInformation, String, String, String, IList<String>, ApiVersionSetContractDetails)

Initialise une nouvelle instance de la classe ApiContract.

Propriétés

ApiRevision

Obtient ou définit décrit la révision de l’API. Si aucune valeur n’est fournie, la révision par défaut 1 est créée

ApiRevisionDescription

Obtient ou définit la description de la révision de l’API.

ApiType

Obtient ou définit le type d’API. Les valeurs possibles sont les suivantes : « http », « soap », « websocket », « graphql »

ApiVersion

Obtient ou définit indique l’identificateur de version de l’API si l’API est avec version

ApiVersionDescription

Obtient ou définit la description de la version de l’API.

ApiVersionSet

Obtient ou définit les détails du jeu de versions

ApiVersionSetId

Obtient ou définit un identificateur de ressource pour l’ApiVersionSet associé.

AuthenticationSettings

Obtient ou définit la collection de paramètres d’authentification inclus dans cette API.

Contact

Obtient ou définit les informations de contact pour l’API.

Description

Obtient ou définit la description de l’API. Peut comporter des balises de mise en forme.

DisplayName

Obtient ou définit le nom de l’API. Doit comporter entre 1 et 300 caractères.

Id

Obtient l’ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

(Hérité de Resource)
IsCurrent

Obtient ou définit indique si la révision d’API est une révision d’API actuelle.

IsOnline

Obtient indique si la révision de l’API est accessible via la passerelle.

License

Obtient ou définit les informations de licence pour l’API.

Name

Obtient le nom de la ressource

(Hérité de Resource)
Path

Obtient ou définit une URL relative identifiant de manière unique cette API et tous ses chemins de ressources dans le instance de service Gestion des API. Elle est ajoutée à l’URL de base du point de terminaison d’API spécifiée lors de la création de l’instance de service pour former l’URL publique de cette API.

Protocols

Obtient ou définit décrit les protocoles sur lesquels les opérations de cette API peuvent être appelées.

ServiceUrl

Obtient ou définit l’URL absolue du service principal qui implémente cette API. Ne peut pas avoir plus de 2 000 caractères.

SourceApiId

Obtient ou définit l’identificateur d’API de l’API source.

SubscriptionKeyParameterNames

Obtient ou définit les protocoles sur lesquels l’API est mise à disposition.

SubscriptionRequired

Obtient ou définit spécifie si un abonnement d’API ou de produit est requis pour accéder à l’API.

TermsOfServiceUrl

Obtient ou définit l’URL A sur les conditions d’utilisation de l’API. DOIT être au format d’une URL.

Type

Obtient le type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

(Hérité de Resource)

Méthodes

Validate()

Validez l’objet .

S’applique à