Subscription interface
Interface die een abonnement vertegenwoordigt.
Methoden
| create |
Hiermee wordt het abonnement van de opgegeven gebruiker voor het opgegeven product gemaakt of bijgewerkt. |
| delete(string, string, string, string, Subscription |
Hiermee verwijdert u het opgegeven abonnement. |
| get(string, string, string, Subscription |
Hiermee haalt u de opgegeven abonnementsentiteit op. |
| get |
Hiermee haalt u de versie van de entiteitsstatus (Etag) op van het apimanagement-abonnement dat is opgegeven door de id. |
| list(string, string, Subscription |
Een lijst met alle abonnementen van het API Management service-exemplaar. |
| list |
Hiermee haalt u de opgegeven abonnementssleutels op. |
| regenerate |
Hiermee wordt de primaire sleutel van het bestaande abonnement van het API Management service-exemplaar opnieuw gegenereerd. |
| regenerate |
Hiermee wordt de secundaire sleutel van het bestaande abonnement van het API Management service-exemplaar opnieuw gegenereerd. |
| update(string, string, string, string, Subscription |
Updates de details van een abonnement dat is opgegeven door de id. |
Methodedetails
createOrUpdate(string, string, string, SubscriptionCreateParameters, SubscriptionCreateOrUpdateOptionalParams)
Hiermee wordt het abonnement van de opgegeven gebruiker voor het opgegeven product gemaakt of bijgewerkt.
function createOrUpdate(resourceGroupName: string, serviceName: string, sid: string, parameters: SubscriptionCreateParameters, options?: SubscriptionCreateOrUpdateOptionalParams): Promise<SubscriptionCreateOrUpdateResponse>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- sid
-
string
Id van abonnementsentiteit. De entiteit vertegenwoordigt de koppeling tussen een gebruiker en een product in API Management.
- parameters
- SubscriptionCreateParameters
Parameters maken.
De optiesparameters.
Retouren
Promise<SubscriptionCreateOrUpdateResponse>
delete(string, string, string, string, SubscriptionDeleteOptionalParams)
Hiermee verwijdert u het opgegeven abonnement.
function delete(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, options?: SubscriptionDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- sid
-
string
Id van abonnementsentiteit. De entiteit vertegenwoordigt de koppeling tussen een gebruiker en een product in API Management.
- ifMatch
-
string
ETag van de entiteit. ETag moet overeenkomen met de huidige entiteitsstatus uit het headerantwoord van de GET-aanvraag of moet * zijn voor onvoorwaardelijke update.
- options
- SubscriptionDeleteOptionalParams
De optiesparameters.
Retouren
Promise<void>
get(string, string, string, SubscriptionGetOptionalParams)
Hiermee haalt u de opgegeven abonnementsentiteit op.
function get(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetOptionalParams): Promise<SubscriptionGetResponse>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- sid
-
string
Id van abonnementsentiteit. De entiteit vertegenwoordigt de koppeling tussen een gebruiker en een product in API Management.
- options
- SubscriptionGetOptionalParams
De optiesparameters.
Retouren
Promise<SubscriptionGetResponse>
getEntityTag(string, string, string, SubscriptionGetEntityTagOptionalParams)
Hiermee haalt u de versie van de entiteitsstatus (Etag) op van het apimanagement-abonnement dat is opgegeven door de id.
function getEntityTag(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetEntityTagOptionalParams): Promise<SubscriptionGetEntityTagHeaders>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- sid
-
string
Id van abonnementsentiteit. De entiteit vertegenwoordigt de koppeling tussen een gebruiker en een product in API Management.
De optiesparameters.
Retouren
Promise<SubscriptionGetEntityTagHeaders>
list(string, string, SubscriptionListOptionalParams)
Een lijst met alle abonnementen van het API Management service-exemplaar.
function list(resourceGroupName: string, serviceName: string, options?: SubscriptionListOptionalParams): PagedAsyncIterableIterator<SubscriptionContract, SubscriptionContract[], PageSettings>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- options
- SubscriptionListOptionalParams
De optiesparameters.
Retouren
listSecrets(string, string, string, SubscriptionListSecretsOptionalParams)
Hiermee haalt u de opgegeven abonnementssleutels op.
function listSecrets(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionListSecretsOptionalParams): Promise<SubscriptionListSecretsResponse>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- sid
-
string
Id van abonnementsentiteit. De entiteit vertegenwoordigt de koppeling tussen een gebruiker en een product in API Management.
De optiesparameters.
Retouren
Promise<SubscriptionListSecretsResponse>
regeneratePrimaryKey(string, string, string, SubscriptionRegeneratePrimaryKeyOptionalParams)
Hiermee wordt de primaire sleutel van het bestaande abonnement van het API Management service-exemplaar opnieuw gegenereerd.
function regeneratePrimaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegeneratePrimaryKeyOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- sid
-
string
Id van abonnementsentiteit. De entiteit vertegenwoordigt de koppeling tussen een gebruiker en een product in API Management.
De optiesparameters.
Retouren
Promise<void>
regenerateSecondaryKey(string, string, string, SubscriptionRegenerateSecondaryKeyOptionalParams)
Hiermee wordt de secundaire sleutel van het bestaande abonnement van het API Management service-exemplaar opnieuw gegenereerd.
function regenerateSecondaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegenerateSecondaryKeyOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- sid
-
string
Id van abonnementsentiteit. De entiteit vertegenwoordigt de koppeling tussen een gebruiker en een product in API Management.
De optiesparameters.
Retouren
Promise<void>
update(string, string, string, string, SubscriptionUpdateParameters, SubscriptionUpdateOptionalParams)
Updates de details van een abonnement dat is opgegeven door de id.
function update(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, parameters: SubscriptionUpdateParameters, options?: SubscriptionUpdateOptionalParams): Promise<SubscriptionUpdateResponse>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- sid
-
string
Id van abonnementsentiteit. De entiteit vertegenwoordigt de koppeling tussen een gebruiker en een product in API Management.
- ifMatch
-
string
ETag van de entiteit. ETag moet overeenkomen met de huidige entiteitsstatus uit het headerantwoord van de GET-aanvraag of moet * zijn voor onvoorwaardelijke update.
- parameters
- SubscriptionUpdateParameters
Parameters bijwerken.
- options
- SubscriptionUpdateOptionalParams
De optiesparameters.
Retouren
Promise<SubscriptionUpdateResponse>