Freigeben über


SubscriptionContract interface

Abonnementdetails.

Extends

Eigenschaften

allowTracing

Bestimmt, ob die Ablaufverfolgung aktiviert ist.

createdDate

Erstellungsdatum des Abonnements. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ gemäß der ISO 8601-Norm.

HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

displayName

Der Name des Abonnements oder NULL, wenn das Abonnement keinen Namen hat.

endDate

Datum, an dem das Abonnement gekündigt oder abgelaufen ist. Die Einstellung dient nur zu Überwachungszwecken, und das Abonnement wird nicht automatisch gekündigt. Der Abonnementlebenszyklus kann mithilfe der eigenschaft state verwaltet werden. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ gemäß der ISO 8601-Norm.

expirationDate

Ablaufdatum des Abonnements. Die Einstellung dient nur zu Überwachungszwecken, und das Abonnement ist nicht automatisch abgelaufen. Der Abonnementlebenszyklus kann mithilfe der eigenschaft state verwaltet werden. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ gemäß der ISO 8601-Norm.

notificationDate

Ablaufdatum des bevorstehenden Abonnements. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ gemäß der ISO 8601-Norm.

ownerId

Der Benutzerressourcenbezeichner des Abonnementbesitzers. Der Wert ist eine gültige relative URL im Format von /users/{userId}, wobei {userId} ein Benutzerbezeichner ist.

primaryKey

Primärschlüssel des Abonnements. Diese Eigenschaft wird für 'GET'-Vorgänge nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen.

scope

Bereich wie /products/{productId} oder /apis oder /apis/{apiId}.

secondaryKey

Sekundärer Abonnementschlüssel. Diese Eigenschaft wird für 'GET'-Vorgänge nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen.

startDate

Datum der Abonnementaktivierung. Die Einstellung dient nur zu Überwachungszwecken, und das Abonnement wird nicht automatisch aktiviert. Der Abonnementlebenszyklus kann mithilfe der eigenschaft state verwaltet werden. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ gemäß der ISO 8601-Norm.

state

Abonnementstatus. Mögliche Zustände sind * aktiv – das Abonnement ist aktiv, * ausgesetzt – das Abonnement wird blockiert, und der Abonnent kann keine APIs des Produkts anrufen, * übermittelt – die Abonnementanforderung wurde vom Entwickler vorgenommen, wurde aber noch nicht genehmigt oder abgelehnt, * abgelehnt – die Abonnementanforderung wurde von einem Administrator verweigert * gekündigt – das Abonnement wurde vom Entwickler oder Administrator storniert, * abgelaufen – das Abonnement hat sein Ablaufdatum erreicht und wurde deaktiviert.

stateComment

Optionaler Abonnementkommentar, der von einem Administrator hinzugefügt wird, wenn der Status in "abgelehnt" geändert wird.

Geerbte Eigenschaften

id

Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

name

Der Name der RessourcenHINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

type

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts": Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

Details zur Eigenschaft

allowTracing

Bestimmt, ob die Ablaufverfolgung aktiviert ist.

allowTracing?: boolean

Eigenschaftswert

boolean

createdDate

Erstellungsdatum des Abonnements. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ gemäß der ISO 8601-Norm.

HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

createdDate?: Date

Eigenschaftswert

Date

displayName

Der Name des Abonnements oder NULL, wenn das Abonnement keinen Namen hat.

displayName?: string

Eigenschaftswert

string

endDate

Datum, an dem das Abonnement gekündigt oder abgelaufen ist. Die Einstellung dient nur zu Überwachungszwecken, und das Abonnement wird nicht automatisch gekündigt. Der Abonnementlebenszyklus kann mithilfe der eigenschaft state verwaltet werden. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ gemäß der ISO 8601-Norm.

endDate?: Date

Eigenschaftswert

Date

expirationDate

Ablaufdatum des Abonnements. Die Einstellung dient nur zu Überwachungszwecken, und das Abonnement ist nicht automatisch abgelaufen. Der Abonnementlebenszyklus kann mithilfe der eigenschaft state verwaltet werden. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ gemäß der ISO 8601-Norm.

expirationDate?: Date

Eigenschaftswert

Date

notificationDate

Ablaufdatum des bevorstehenden Abonnements. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ gemäß der ISO 8601-Norm.

notificationDate?: Date

Eigenschaftswert

Date

ownerId

Der Benutzerressourcenbezeichner des Abonnementbesitzers. Der Wert ist eine gültige relative URL im Format von /users/{userId}, wobei {userId} ein Benutzerbezeichner ist.

ownerId?: string

Eigenschaftswert

string

primaryKey

Primärschlüssel des Abonnements. Diese Eigenschaft wird für 'GET'-Vorgänge nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen.

primaryKey?: string

Eigenschaftswert

string

scope

Bereich wie /products/{productId} oder /apis oder /apis/{apiId}.

scope?: string

Eigenschaftswert

string

secondaryKey

Sekundärer Abonnementschlüssel. Diese Eigenschaft wird für 'GET'-Vorgänge nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen.

secondaryKey?: string

Eigenschaftswert

string

startDate

Datum der Abonnementaktivierung. Die Einstellung dient nur zu Überwachungszwecken, und das Abonnement wird nicht automatisch aktiviert. Der Abonnementlebenszyklus kann mithilfe der eigenschaft state verwaltet werden. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ gemäß der ISO 8601-Norm.

startDate?: Date

Eigenschaftswert

Date

state

Abonnementstatus. Mögliche Zustände sind * aktiv – das Abonnement ist aktiv, * ausgesetzt – das Abonnement wird blockiert, und der Abonnent kann keine APIs des Produkts anrufen, * übermittelt – die Abonnementanforderung wurde vom Entwickler vorgenommen, wurde aber noch nicht genehmigt oder abgelehnt, * abgelehnt – die Abonnementanforderung wurde von einem Administrator verweigert * gekündigt – das Abonnement wurde vom Entwickler oder Administrator storniert, * abgelaufen – das Abonnement hat sein Ablaufdatum erreicht und wurde deaktiviert.

state?: SubscriptionState

Eigenschaftswert

stateComment

Optionaler Abonnementkommentar, der von einem Administrator hinzugefügt wird, wenn der Status in "abgelehnt" geändert wird.

stateComment?: string

Eigenschaftswert

string

Geerbte Eigenschaftsdetails

id

Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

id?: string

Eigenschaftswert

string

geerbt vonProxyResource.id

name

Der Name der RessourcenHINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

name?: string

Eigenschaftswert

string

geerbt vonProxyResource.name

type

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts": Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

type?: string

Eigenschaftswert

string

von"ProxyResource.type" geerbt