SubscriptionUpdateParameters interface

Pakiet:

@azure/arm-apimanagement

Szczegóły aktualizacji subskrypcji.

Właściwości

allowTracing	Określa, czy można włączyć śledzenie
displayName	Nazwa subskrypcji.
expirationDate	Data wygaśnięcia subskrypcji. Ustawienie jest przeznaczone tylko do celów inspekcji, a subskrypcja nie wygasła automatycznie. Cykl życia subskrypcji można zarządzać przy użyciu właściwości state. Data jest zgodna z następującym formatem: yyyy-MM-ddTHH:mm:ssZ określony przez standard ISO 8601.
ownerId	Ścieżka identyfikatora użytkownika: /users/{userId}
primaryKey	Podstawowy klucz subskrypcji.
scope	Zakres, taki jak /products/{productId} lub /apis lub /apis/{apiId}
secondaryKey	Pomocniczy klucz subskrypcji.
state	Stan subskrypcji. Możliwe stany są * aktywne — subskrypcja jest aktywna, * zawieszona — subskrypcja jest zablokowana, a subskrybent nie może wywołać żadnych interfejsów API produktu, * przesłane — żądanie subskrypcji zostało złożone przez dewelopera, ale nie zostało jeszcze zatwierdzone lub odrzucone, * odrzucono — żądanie subskrypcji zostało odrzucone przez administratora, * anulowane — subskrypcja została anulowana przez dewelopera lub administratora, * wygasła — subskrypcja osiągnęła datę wygaśnięcia i została zdezaktywowana.
stateComment	Komentarze opisujące zmianę stanu subskrypcji przez administratora, gdy stan zostanie zmieniony na "odrzucony".

Szczegóły właściwości

allowTracing

Określa, czy można włączyć śledzenie

allowTracing?: boolean

Wartość właściwości

boolean

displayName

Nazwa subskrypcji.

displayName?: string

Wartość właściwości

string

expirationDate

Data wygaśnięcia subskrypcji. Ustawienie jest przeznaczone tylko do celów inspekcji, a subskrypcja nie wygasła automatycznie. Cykl życia subskrypcji można zarządzać przy użyciu właściwości state. Data jest zgodna z następującym formatem: yyyy-MM-ddTHH:mm:ssZ określony przez standard ISO 8601.

expirationDate?: Date

Wartość właściwości

Date

ownerId

Ścieżka identyfikatora użytkownika: /users/{userId}

ownerId?: string

Wartość właściwości

string

primaryKey

Podstawowy klucz subskrypcji.

primaryKey?: string

Wartość właściwości

string

scope

Zakres, taki jak /products/{productId} lub /apis lub /apis/{apiId}

scope?: string

Wartość właściwości

string

secondaryKey

Pomocniczy klucz subskrypcji.

secondaryKey?: string

Wartość właściwości

string

state

Stan subskrypcji. Możliwe stany są * aktywne — subskrypcja jest aktywna, * zawieszona — subskrypcja jest zablokowana, a subskrybent nie może wywołać żadnych interfejsów API produktu, * przesłane — żądanie subskrypcji zostało złożone przez dewelopera, ale nie zostało jeszcze zatwierdzone lub odrzucone, * odrzucono — żądanie subskrypcji zostało odrzucone przez administratora, * anulowane — subskrypcja została anulowana przez dewelopera lub administratora, * wygasła — subskrypcja osiągnęła datę wygaśnięcia i została zdezaktywowana.

state?: SubscriptionState

Wartość właściwości

SubscriptionState

stateComment

Komentarze opisujące zmianę stanu subskrypcji przez administratora, gdy stan zostanie zmieniony na "odrzucony".

stateComment?: string

Wartość właściwości

string