SubscriptionUpdateParameters interface
Előfizetés frissítésének részletei.
Tulajdonságok
| allow |
Meghatározza, hogy engedélyezhető-e a nyomkövetés |
| display |
Előfizetés neve. |
| expiration |
Az előfizetés lejárati dátuma. A beállítás csak naplózási célokra szolgál, és az előfizetés nem járt le automatikusan. Az előfizetés életciklusa a |
| owner |
Felhasználói azonosító elérési útja: /users/{userId} |
| primary |
Elsődleges előfizetési kulcs. |
| scope | Hatókör, például /products/{productId} vagy /apis vagy /apis/{apiId} |
| secondary |
Másodlagos előfizetési kulcs. |
| state | Előfizetés állapota. Lehetséges állapotok * aktívak – az előfizetés aktív, * felfüggesztve – az előfizetés le van tiltva, és az előfizető nem hívhatja meg a termék API-jait, * benyújtotta – az előfizetési kérelmet a fejlesztő küldte, de még nem hagyta jóvá vagy nem utasította el, * elutasítva – az előfizetési kérelmet egy rendszergazda tagadta meg, * lemondta – az előfizetést a fejlesztő vagy a rendszergazda törölte, * lejárt – az előfizetés elérte a lejárati dátumát, és inaktiválta. |
| state |
A rendszergazda által az előfizetés állapotának változását leíró megjegyzések, amikor az állapot "elutasítva" állapotra módosul. |
Tulajdonság adatai
allowTracing
Meghatározza, hogy engedélyezhető-e a nyomkövetés
allowTracing?: boolean
Tulajdonság értéke
boolean
displayName
Előfizetés neve.
displayName?: string
Tulajdonság értéke
string
expirationDate
Az előfizetés lejárati dátuma. A beállítás csak naplózási célokra szolgál, és az előfizetés nem járt le automatikusan. Az előfizetés életciklusa a state tulajdonság használatával kezelhető. A dátum a következő formátumnak felel meg: yyyy-MM-ddTHH:mm:ssZ az ISO 8601 szabványnak megfelelően.
expirationDate?: Date
Tulajdonság értéke
Date
ownerId
Felhasználói azonosító elérési útja: /users/{userId}
ownerId?: string
Tulajdonság értéke
string
primaryKey
Elsődleges előfizetési kulcs.
primaryKey?: string
Tulajdonság értéke
string
scope
Hatókör, például /products/{productId} vagy /apis vagy /apis/{apiId}
scope?: string
Tulajdonság értéke
string
secondaryKey
Másodlagos előfizetési kulcs.
secondaryKey?: string
Tulajdonság értéke
string
state
Előfizetés állapota. Lehetséges állapotok * aktívak – az előfizetés aktív, * felfüggesztve – az előfizetés le van tiltva, és az előfizető nem hívhatja meg a termék API-jait, * benyújtotta – az előfizetési kérelmet a fejlesztő küldte, de még nem hagyta jóvá vagy nem utasította el, * elutasítva – az előfizetési kérelmet egy rendszergazda tagadta meg, * lemondta – az előfizetést a fejlesztő vagy a rendszergazda törölte, * lejárt – az előfizetés elérte a lejárati dátumát, és inaktiválta.
state?: SubscriptionState
Tulajdonság értéke
stateComment
A rendszergazda által az előfizetés állapotának változását leíró megjegyzések, amikor az állapot "elutasítva" állapotra módosul.
stateComment?: string
Tulajdonság értéke
string