Dela via

SubscriptionCreateParameters interface

  • Referens
Paket:
@azure/arm-apimanagement

Information om prenumerationsskapande.

Egenskaper

allowTracing

Avgör om spårning kan aktiveras
displayName

Prenumerationsnamn.
ownerId

Användare (sökväg till användar-ID) för vilken prenumerationen skapas i formulär /users/{userId}
primaryKey

Primär prenumerationsnyckel. Om det inte anges under begäran genereras nyckeln automatiskt.
scope

Omfång som /products/{productId} eller /apis eller /apis/{apiId}.
secondaryKey

Sekundär prenumerationsnyckel. Om det inte anges under begäran genereras nyckeln automatiskt.
state

Ursprungligt prenumerationstillstånd. Om inget värde anges skapas prenumerationen med tillståndet Skickad. Möjliga tillstånd är * aktiva – prenumerationen är aktiv, * pausad – prenumerationen blockeras och prenumeranten kan inte anropa några API:er för produkten, * skickad – prenumerationsbegäran har gjorts av utvecklaren, men har ännu inte godkänts eller avvisats, * avvisats – prenumerationsbegäran har nekats av en administratör, * avbrutits – prenumerationen har avbrutits av utvecklaren eller administratören. * har upphört att gälla – prenumerationen har nått sitt förfallodatum och inaktiverats.

Egenskapsinformation

allowTracing

Avgör om spårning kan aktiveras

allowTracing?: boolean

Egenskapsvärde

boolean

displayName

Prenumerationsnamn.

displayName?: string

Egenskapsvärde

string

ownerId

Användare (sökväg till användar-ID) för vilken prenumerationen skapas i formulär /users/{userId}

ownerId?: string

Egenskapsvärde

string

primaryKey

Primär prenumerationsnyckel. Om det inte anges under begäran genereras nyckeln automatiskt.

primaryKey?: string

Egenskapsvärde

string

scope

Omfång som /products/{productId} eller /apis eller /apis/{apiId}.

scope?: string

Egenskapsvärde

string

secondaryKey

Sekundär prenumerationsnyckel. Om det inte anges under begäran genereras nyckeln automatiskt.

secondaryKey?: string

Egenskapsvärde

string

state

Ursprungligt prenumerationstillstånd. Om inget värde anges skapas prenumerationen med tillståndet Skickad. Möjliga tillstånd är * aktiva – prenumerationen är aktiv, * pausad – prenumerationen blockeras och prenumeranten kan inte anropa några API:er för produkten, * skickad – prenumerationsbegäran har gjorts av utvecklaren, men har ännu inte godkänts eller avvisats, * avvisats – prenumerationsbegäran har nekats av en administratör, * avbrutits – prenumerationen har avbrutits av utvecklaren eller administratören. * har upphört att gälla – prenumerationen har nått sitt förfallodatum och inaktiverats.

state?: SubscriptionState

Egenskapsvärde

SubscriptionState