ApiContract Klasse
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
API-Details.
[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
- Vererbung
- Attribute
Konstruktoren
ApiContract() |
Initialisiert einen neuen instance der ApiContract-Klasse. |
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) |
Initialisiert einen neuen instance der ApiContract-Klasse. |
Eigenschaften
ApiRevision |
Ruft die Revision der API ab oder legt sie fest. Wenn kein Wert angegeben wird, wird die Standardrevision 1 erstellt. |
ApiRevisionDescription |
Ruft die Beschreibung der API-Revision ab oder legt diese fest. |
ApiType |
Ruft den Typ der API ab oder legt den Typ fest. Mögliche Werte: "http", "soap", "websocket", "graphql" |
ApiVersion |
Ruft den Versionsbezeichner der API ab oder legt diese fest, wenn die API eine Versionsangabe aufweist. |
ApiVersionDescription |
Ruft die Beschreibung der API-Version ab oder legt diese fest. |
ApiVersionSet |
Ruft Versionssatzdetails ab oder legt sie fest. |
ApiVersionSetId |
Ruft einen Ressourcenbezeichner für das zugehörige ApiVersionSet ab oder legt diese fest. |
AuthenticationSettings |
Ruft die Sammlung von Authentifizierungseinstellungen ab, die in dieser API enthalten sind, oder legt diese fest. |
Contact |
Ruft Kontaktinformationen für die API ab oder legt diese fest. |
Description |
Ruft die Beschreibung der API ab oder legt diese fest. Kann HTML-Formatierungstags umfassen. |
DisplayName |
Ruft den API-Namen ab oder legt den Namen fest. Muss 1 bis 300 Zeichen lang sein. |
Id |
Ruft die vollqualifizierte Ressourcen-ID für die Ressource ab. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} (Geerbt von Resource) |
IsCurrent |
Ruft ab oder legt fest, ob die API-Revision die aktuelle API-Revision ist. |
IsOnline |
Ruft an, ob auf die API-Revision über das Gateway zugegriffen werden kann. |
License |
Ruft Lizenzinformationen für die API ab oder legt diese fest. |
Name |
Ruft den Namen der Ressource ab. (Geerbt von Resource) |
Path |
Ruft die relative URL ab, die diese API und alle Ressourcenpfade innerhalb des API Management-Diensts eindeutig instance identifiziert, oder legt diese fest. Sie wird an die Basis-URL des API-Endpunkts angehängt, die während der Dienstinstanzerstellung angegeben wurde, um eine öffentliche URL für diese API zu erstellen. |
Protocols |
Ruft ab oder legt fest, für welche Protokolle die Vorgänge in dieser API aufgerufen werden können. |
ServiceUrl |
Ruft die absolute URL des Back-End-Diensts ab, der diese API implementiert, oder legt diese fest. Darf nicht mehr als 2.000 Zeichen lang sein. |
SourceApiId |
Ruft den API-Bezeichner der Quell-API ab oder legt diese fest. |
SubscriptionKeyParameterNames |
Ruft Protokolle ab, über die die API verfügbar gemacht wird, oder legt diese fest. |
SubscriptionRequired |
Ruft ab oder legt fest, ob ein API- oder Produktabonnement für den Zugriff auf die API erforderlich ist. |
TermsOfServiceUrl |
Ruft eine URL für die Nutzungsbedingungen für die API ab oder legt sie fest. MUSS im Format einer URL vorliegen. |
Type |
Ruft den Typ der Ressource ab. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" (Geerbt von Resource) |
Methoden
Validate() |
Überprüfen Sie das Objekt. |
Gilt für:
Azure SDK for .NET