Subscription interface
Gränssnitt som representerar en prenumeration.
Metoder
Metodinformation
createOrUpdate(string, string, string, SubscriptionCreateParameters, SubscriptionCreateOrUpdateOptionalParams)
Skapar eller uppdaterar prenumerationen för den angivna användaren till den angivna produkten.
function createOrUpdate(resourceGroupName: string, serviceName: string, sid: string, parameters: SubscriptionCreateParameters, options?: SubscriptionCreateOrUpdateOptionalParams): Promise<SubscriptionCreateOrUpdateResponse>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- sid
-
string
Prenumerationsentitetsidentifierare. Entiteten representerar associationen mellan en användare och en produkt i API Management.
- parameters
- SubscriptionCreateParameters
Skapa parametrar.
Alternativparametrarna.
Returer
Promise<SubscriptionCreateOrUpdateResponse>
delete(string, string, string, string, SubscriptionDeleteOptionalParams)
Tar bort den angivna prenumerationen.
function delete(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, options?: SubscriptionDeleteOptionalParams): Promise<void>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- sid
-
string
Prenumerationsentitetsidentifierare. Entiteten representerar associationen mellan en användare och en produkt i API Management.
- ifMatch
-
string
ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran, eller så bör det vara * för ovillkorlig uppdatering.
- options
- SubscriptionDeleteOptionalParams
Alternativparametrarna.
Returer
Promise<void>
get(string, string, string, SubscriptionGetOptionalParams)
Hämtar den angivna prenumerationsentiteten.
function get(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetOptionalParams): Promise<SubscriptionGetResponse>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- sid
-
string
Prenumerationsentitetsidentifierare. Entiteten representerar associationen mellan en användare och en produkt i API Management.
- options
- SubscriptionGetOptionalParams
Alternativparametrarna.
Returer
Promise<SubscriptionGetResponse>
getEntityTag(string, string, string, SubscriptionGetEntityTagOptionalParams)
Hämtar entitetstillståndsversionen (Etag) för apimanagement-prenumerationen som anges av dess identifierare.
function getEntityTag(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetEntityTagOptionalParams): Promise<SubscriptionGetEntityTagHeaders>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- sid
-
string
Prenumerationsentitetsidentifierare. Entiteten representerar associationen mellan en användare och en produkt i API Management.
Alternativparametrarna.
Returer
Promise<SubscriptionGetEntityTagHeaders>
list(string, string, SubscriptionListOptionalParams)
Visar en lista över alla prenumerationer på API Management-tjänstinstansen.
function list(resourceGroupName: string, serviceName: string, options?: SubscriptionListOptionalParams): PagedAsyncIterableIterator<SubscriptionContract, SubscriptionContract[], PageSettings>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- options
- SubscriptionListOptionalParams
Alternativparametrarna.
Returer
listSecrets(string, string, string, SubscriptionListSecretsOptionalParams)
Hämtar de angivna prenumerationsnycklarna.
function listSecrets(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionListSecretsOptionalParams): Promise<SubscriptionListSecretsResponse>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- sid
-
string
Prenumerationsentitetsidentifierare. Entiteten representerar associationen mellan en användare och en produkt i API Management.
Alternativparametrarna.
Returer
Promise<SubscriptionListSecretsResponse>
regeneratePrimaryKey(string, string, string, SubscriptionRegeneratePrimaryKeyOptionalParams)
Återskapar primärnyckeln för den befintliga prenumerationen för API Management-tjänstinstansen.
function regeneratePrimaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegeneratePrimaryKeyOptionalParams): Promise<void>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- sid
-
string
Prenumerationsentitetsidentifierare. Entiteten representerar associationen mellan en användare och en produkt i API Management.
Alternativparametrarna.
Returer
Promise<void>
regenerateSecondaryKey(string, string, string, SubscriptionRegenerateSecondaryKeyOptionalParams)
Återskapar sekundärnyckeln för den befintliga prenumerationen på API Management-tjänstinstansen.
function regenerateSecondaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegenerateSecondaryKeyOptionalParams): Promise<void>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- sid
-
string
Prenumerationsentitetsidentifierare. Entiteten representerar associationen mellan en användare och en produkt i API Management.
Alternativparametrarna.
Returer
Promise<void>
update(string, string, string, string, SubscriptionUpdateParameters, SubscriptionUpdateOptionalParams)
Uppdateringar information om en prenumeration som anges av dess identifierare.
function update(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, parameters: SubscriptionUpdateParameters, options?: SubscriptionUpdateOptionalParams): Promise<SubscriptionUpdateResponse>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- sid
-
string
Prenumerationsentitetsidentifierare. Entiteten representerar associationen mellan en användare och en produkt i API Management.
- ifMatch
-
string
ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran, eller så bör det vara * för ovillkorlig uppdatering.
- parameters
- SubscriptionUpdateParameters
Uppdatera parametrar.
- options
- SubscriptionUpdateOptionalParams
Alternativparametrarna.
Returer
Promise<SubscriptionUpdateResponse>