SubscriptionUpdateParameters interface
Details zum Abonnementupdate.
Eigenschaften
| allow |
Bestimmt, ob die Ablaufverfolgung aktiviert werden kann |
| display |
Abonnementname. |
| expiration |
Ablaufdatum des Abonnements. Die Einstellung dient nur zu Überwachungszwecken, und das Abonnement ist nicht automatisch abgelaufen. Der Abonnementlebenszyklus kann mithilfe der eigenschaft |
| owner |
Benutzerbezeichnerpfad: /users/{userId} |
| primary |
Primärer Abonnementschlüssel. |
| scope | Bereich wie /products/{productId} oder /apis oder /apis/{apiId} |
| secondary |
Sekundärer Abonnementschlüssel. |
| 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 |
Kommentare zur Beschreibung der Änderung des Abonnementstatus durch den Administrator, wenn der Status in "abgelehnt" geändert wird. |
Details zur Eigenschaft
allowTracing
Bestimmt, ob die Ablaufverfolgung aktiviert werden kann
allowTracing?: boolean
Eigenschaftswert
boolean
displayName
Abonnementname.
displayName?: string
Eigenschaftswert
string
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
ownerId
Benutzerbezeichnerpfad: /users/{userId}
ownerId?: string
Eigenschaftswert
string
primaryKey
Primärer Abonnementschlüssel.
primaryKey?: string
Eigenschaftswert
string
scope
Bereich wie /products/{productId} oder /apis oder /apis/{apiId}
scope?: string
Eigenschaftswert
string
secondaryKey
Sekundärer Abonnementschlüssel.
secondaryKey?: string
Eigenschaftswert
string
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
Kommentare zur Beschreibung der Änderung des Abonnementstatus durch den Administrator, wenn der Status in "abgelehnt" geändert wird.
stateComment?: string
Eigenschaftswert
string