SubscriptionContract interface

Pakiet:

@azure/arm-apimanagement

Szczegóły subskrypcji.

Rozszerzenie

ProxyResource

Właściwości

allowTracing	Określa, czy śledzenie jest włączone
createdDate	Data utworzenia subskrypcji. Data jest zgodna z następującym formatem: yyyy-MM-ddTHH:mm:ssZ określony przez standard ISO 8601. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
displayName	Nazwa subskrypcji lub wartość null, jeśli subskrypcja nie ma nazwy.
endDate	Data anulowania lub wygaśnięcia subskrypcji. Ustawienie jest przeznaczone tylko do celów inspekcji, a subskrypcja nie jest automatycznie anulowana. 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	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.
notificationDate	Zbliżająca się data powiadomienia o wygaśnięciu subskrypcji. Data jest zgodna z następującym formatem: yyyy-MM-ddTHH:mm:ssZ określony przez standard ISO 8601.
ownerId	Identyfikator zasobu użytkownika właściciela subskrypcji. Wartość jest prawidłowym względnym adresem URL w formacie /users/{userId}, gdzie {userId} jest identyfikatorem użytkownika.
primaryKey	Klucz podstawowy subskrypcji. Ta właściwość nie zostanie wypełniona na operacjach "GET". Użyj żądania POST "/listSecrets", aby uzyskać wartość.
scope	Zakres, taki jak /products/{productId} lub /apis lub /apis/{apiId}.
secondaryKey	Klucz pomocniczy subskrypcji. Ta właściwość nie zostanie wypełniona na operacjach "GET". Użyj żądania POST "/listSecrets", aby uzyskać wartość.
startDate	Data aktywacji subskrypcji. Ustawienie jest przeznaczone tylko do celów inspekcji, a subskrypcja nie jest aktywowana 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.
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	Opcjonalny komentarz subskrypcji dodany przez administratora po zmianie stanu na "odrzucony".

Właściwości dziedziczone

id	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
name	Nazwa zasobu UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
type	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts" UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

Szczegóły właściwości

allowTracing

Określa, czy śledzenie jest włączone

allowTracing?: boolean

Wartość właściwości

boolean

createdDate

Data utworzenia subskrypcji. Data jest zgodna z następującym formatem: yyyy-MM-ddTHH:mm:ssZ określony przez standard ISO 8601.

UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

createdDate?: Date

Wartość właściwości

Date

displayName

Nazwa subskrypcji lub wartość null, jeśli subskrypcja nie ma nazwy.

displayName?: string

Wartość właściwości

string

endDate

Data anulowania lub wygaśnięcia subskrypcji. Ustawienie jest przeznaczone tylko do celów inspekcji, a subskrypcja nie jest automatycznie anulowana. 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.

endDate?: Date

Wartość właściwości

Date

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

notificationDate

Zbliżająca się data powiadomienia o wygaśnięciu subskrypcji. Data jest zgodna z następującym formatem: yyyy-MM-ddTHH:mm:ssZ określony przez standard ISO 8601.

notificationDate?: Date

Wartość właściwości

Date

ownerId

Identyfikator zasobu użytkownika właściciela subskrypcji. Wartość jest prawidłowym względnym adresem URL w formacie /users/{userId}, gdzie {userId} jest identyfikatorem użytkownika.

ownerId?: string

Wartość właściwości

string

primaryKey

Klucz podstawowy subskrypcji. Ta właściwość nie zostanie wypełniona na operacjach "GET". Użyj żądania POST "/listSecrets", aby uzyskać wartość.

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

Klucz pomocniczy subskrypcji. Ta właściwość nie zostanie wypełniona na operacjach "GET". Użyj żądania POST "/listSecrets", aby uzyskać wartość.

secondaryKey?: string

Wartość właściwości

string

startDate

Data aktywacji subskrypcji. Ustawienie jest przeznaczone tylko do celów inspekcji, a subskrypcja nie jest aktywowana 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.

startDate?: Date

Wartość właściwości

Date

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

Opcjonalny komentarz subskrypcji dodany przez administratora po zmianie stanu na "odrzucony".

stateComment?: string

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

id

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

id?: string

Wartość właściwości

string

dziedziczone zProxyResource.id

name

Nazwa zasobu UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

name?: string

Wartość właściwości

string

dziedziczone zProxyResource.name

type

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts" UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

type?: string

Wartość właściwości

string

dziedziczone zProxyResource.type