SubscriptionCreateParameters interface
Abonnementdetails erstellen.
Eigenschaften
| allow |
Bestimmt, ob die Ablaufverfolgung aktiviert werden kann |
| display |
Abonnementname. |
| owner |
Benutzer (Benutzer-ID-Pfad), für den das Abonnement in Form /users/{userId} erstellt wird |
| primary |
Primärer Abonnementschlüssel. Wenn während des Anforderungsschlüssels nicht angegeben wird, wird automatisch generiert. |
| scope | Bereich wie /products/{productId} oder /apis oder /apis/{apiId}. |
| secondary |
Sekundärer Abonnementschlüssel. Wenn während des Anforderungsschlüssels nicht angegeben wird, wird automatisch generiert. |
| state | Anfänglicher Abonnementstatus. Wenn kein Wert angegeben ist, wird das Abonnement mit dem Status "Übermittelt" erstellt. 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. |
Details zur Eigenschaft
allowTracing
Bestimmt, ob die Ablaufverfolgung aktiviert werden kann
allowTracing?: boolean
Eigenschaftswert
boolean
displayName
Abonnementname.
displayName?: string
Eigenschaftswert
string
ownerId
Benutzer (Benutzer-ID-Pfad), für den das Abonnement in Form /users/{userId} erstellt wird
ownerId?: string
Eigenschaftswert
string
primaryKey
Primärer Abonnementschlüssel. Wenn während des Anforderungsschlüssels nicht angegeben wird, wird automatisch generiert.
primaryKey?: string
Eigenschaftswert
string
scope
Bereich wie /products/{productId} oder /apis oder /apis/{apiId}.
scope?: string
Eigenschaftswert
string
secondaryKey
Sekundärer Abonnementschlüssel. Wenn während des Anforderungsschlüssels nicht angegeben wird, wird automatisch generiert.
secondaryKey?: string
Eigenschaftswert
string
state
Anfänglicher Abonnementstatus. Wenn kein Wert angegeben ist, wird das Abonnement mit dem Status "Übermittelt" erstellt. 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