Subscription - Update
Updates de details van een abonnement dat is opgegeven door de id.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}?api-version=2022-08-01
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}?notify={notify}&api-version=2022-08-01&appType={appType}
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig. |
service
|
path | True |
string |
De naam van de API Management service. Regex pattern: |
sid
|
path | True |
string |
Id van abonnementsentiteit. De entiteit vertegenwoordigt de koppeling tussen een gebruiker en een product in API Management. Regex pattern: |
subscription
|
path | True |
string |
De id van het doelabonnement. |
api-version
|
query | True |
string |
De API-versie die voor deze bewerking moet worden gebruikt. |
app
|
query |
Bepaalt het type toepassing dat de aanvraag voor het maken van de gebruiker verzendt. De standaardinstelling is de verouderde portal voor uitgevers. |
||
notify
|
query |
boolean |
Wijziging melden in Abonnementsstatus.
|
Aanvraagkoptekst
Name | Vereist | Type | Description |
---|---|---|---|
If-Match | True |
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. |
Aanvraagbody
Name | Type | Description |
---|---|---|
properties.allowTracing |
boolean |
Bepaalt of tracering kan worden ingeschakeld |
properties.displayName |
string |
Abonnementsnaam. |
properties.expirationDate |
string |
Vervaldatum van abonnement. De instelling is alleen bedoeld voor controledoeleinden en het abonnement is niet automatisch verlopen. De levenscyclus van het abonnement kan worden beheerd met behulp van de |
properties.ownerId |
string |
Pad naar gebruikers-id: /users/{userId} |
properties.primaryKey |
string |
Primaire abonnementssleutel. |
properties.scope |
string |
Bereik zoals /products/{productId} of /apis of /apis/{apiId} |
properties.secondaryKey |
string |
Secundaire abonnementssleutel. |
properties.state |
Abonnementsstatus. Mogelijke statussen zijn * actief – het abonnement is actief, * opgeschort – het abonnement is geblokkeerd en de abonnee kan geen API's van het product aanroepen, * ingediend – de abonnementsaanvraag is gedaan door de ontwikkelaar, maar is nog niet goedgekeurd of afgewezen, * geweigerd – de abonnementsaanvraag is geweigerd door een beheerder, * geannuleerd – het abonnement is geannuleerd door de ontwikkelaar of beheerder, * verlopen: het abonnement heeft de vervaldatum bereikt en is gedeactiveerd. |
|
properties.stateComment |
string |
Opmerkingen over het wijzigen van de abonnementsstatus door de beheerder wanneer de status wordt gewijzigd in 'geweigerd'. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
De abonnementsgegevens zijn bijgewerkt. Headers ETag: string |
|
Other Status Codes |
Foutreactie waarin wordt beschreven waarom de bewerking is mislukt. |
Beveiliging
azure_auth
Azure Active Directory OAuth2-stroom.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | uw gebruikersaccount imiteren |
Voorbeelden
ApiManagementUpdateSubscription
Sample Request
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub?api-version=2022-08-01
{
"properties": {
"displayName": "testsub"
}
}
Sample Response
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub",
"type": "Microsoft.ApiManagement/service/subscriptions",
"name": "testsub",
"properties": {
"ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b",
"scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002",
"displayName": "testsub",
"state": "submitted",
"createdDate": "2017-06-02T17:59:06.223Z"
}
}
Definities
Name | Description |
---|---|
App |
Bepaalt het type toepassing dat de aanvraag voor het maken van de gebruiker verzendt. De standaardinstelling is de verouderde portal voor uitgevers. |
Error |
Fout Veldcontract. |
Error |
Foutreactie. |
Subscription |
Abonnementsgegevens. |
Subscription |
Abonnementsstatus. Mogelijke statussen zijn * actief – het abonnement is actief, * opgeschort – het abonnement is geblokkeerd en de abonnee kan geen API's van het product aanroepen, * ingediend – de abonnementsaanvraag is gedaan door de ontwikkelaar, maar is nog niet goedgekeurd of afgewezen, * geweigerd – de abonnementsaanvraag is geweigerd door een beheerder, * geannuleerd – het abonnement is geannuleerd door de ontwikkelaar of beheerder, * verlopen: het abonnement heeft de vervaldatum bereikt en is gedeactiveerd. |
Subscription |
Details van abonnementsupdates. |
AppType
Bepaalt het type toepassing dat de aanvraag voor het maken van de gebruiker verzendt. De standaardinstelling is de verouderde portal voor uitgevers.
Name | Type | Description |
---|---|---|
developerPortal |
string |
Aanvraag voor het maken van gebruikers is verzonden door de nieuwe ontwikkelaarsportal. |
portal |
string |
Aanvraag voor het maken van gebruikers is verzonden door de verouderde ontwikkelaarsportal. |
ErrorFieldContract
Fout Veldcontract.
Name | Type | Description |
---|---|---|
code |
string |
Foutcode op eigenschapsniveau. |
message |
string |
Door mensen leesbare weergave van fout op eigenschapsniveau. |
target |
string |
Naam van eigenschap. |
ErrorResponse
Foutreactie.
Name | Type | Description |
---|---|---|
error.code |
string |
Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord. |
error.details |
De lijst met ongeldige velden verzenden in aanvraag, in het geval van een validatiefout. |
|
error.message |
string |
Door mensen leesbare weergave van de fout. |
SubscriptionContract
Abonnementsgegevens.
Name | Type | Description |
---|---|---|
id |
string |
Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
De naam van de resource |
properties.allowTracing |
boolean |
Bepaalt of tracering is ingeschakeld |
properties.createdDate |
string |
Datum waarop het abonnement is gemaakt. De datum voldoet aan de volgende notatie: |
properties.displayName |
string |
De naam van het abonnement of null als het abonnement geen naam heeft. |
properties.endDate |
string |
Datum waarop het abonnement is geannuleerd of verlopen. De instelling is alleen bedoeld voor controledoeleinden en het abonnement wordt niet automatisch geannuleerd. De levenscyclus van het abonnement kan worden beheerd met behulp van de |
properties.expirationDate |
string |
Vervaldatum van abonnement. De instelling is alleen bedoeld voor controledoeleinden en het abonnement is niet automatisch verlopen. De levenscyclus van het abonnement kan worden beheerd met behulp van de |
properties.notificationDate |
string |
Meldingsdatum voor vervaldatum van aanstaand abonnement. De datum voldoet aan de volgende notatie: |
properties.ownerId |
string |
De gebruikersresource-id van de eigenaar van het abonnement. De waarde is een geldige relatieve URL in de indeling /users/{userId} waarbij {userId} een gebruikers-id is. |
properties.primaryKey |
string |
Primaire sleutel van abonnement. Deze eigenschap wordt niet ingevuld bij 'GET'-bewerkingen! Gebruik post-aanvraag '/listSecrets' om de waarde op te halen. |
properties.scope |
string |
Bereik zoals /products/{productId} of /apis of /apis/{apiId}. |
properties.secondaryKey |
string |
Secundaire sleutel van abonnement. Deze eigenschap wordt niet ingevuld bij 'GET'-bewerkingen! Gebruik post-aanvraag '/listSecrets' om de waarde op te halen. |
properties.startDate |
string |
Activeringsdatum van abonnement. De instelling is alleen bedoeld voor controledoeleinden en het abonnement wordt niet automatisch geactiveerd. De levenscyclus van het abonnement kan worden beheerd met behulp van de |
properties.state |
Abonnementsstatus. Mogelijke statussen zijn * actief – het abonnement is actief, * opgeschort – het abonnement is geblokkeerd en de abonnee kan geen API's van het product aanroepen, * ingediend – de abonnementsaanvraag is gedaan door de ontwikkelaar, maar is nog niet goedgekeurd of afgewezen, * geweigerd – de abonnementsaanvraag is geweigerd door een beheerder, * geannuleerd – het abonnement is geannuleerd door de ontwikkelaar of beheerder, * verlopen: het abonnement heeft de vervaldatum bereikt en is gedeactiveerd. |
|
properties.stateComment |
string |
Optionele abonnementstoemerking toegevoegd door een beheerder wanneer de status wordt gewijzigd in de 'geweigerd'. |
type |
string |
Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts' |
SubscriptionState
Abonnementsstatus. Mogelijke statussen zijn * actief – het abonnement is actief, * opgeschort – het abonnement is geblokkeerd en de abonnee kan geen API's van het product aanroepen, * ingediend – de abonnementsaanvraag is gedaan door de ontwikkelaar, maar is nog niet goedgekeurd of afgewezen, * geweigerd – de abonnementsaanvraag is geweigerd door een beheerder, * geannuleerd – het abonnement is geannuleerd door de ontwikkelaar of beheerder, * verlopen: het abonnement heeft de vervaldatum bereikt en is gedeactiveerd.
Name | Type | Description |
---|---|---|
active |
string |
|
cancelled |
string |
|
expired |
string |
|
rejected |
string |
|
submitted |
string |
|
suspended |
string |
SubscriptionUpdateParameters
Details van abonnementsupdates.
Name | Type | Description |
---|---|---|
properties.allowTracing |
boolean |
Bepaalt of tracering kan worden ingeschakeld |
properties.displayName |
string |
Abonnementsnaam. |
properties.expirationDate |
string |
Vervaldatum van abonnement. De instelling is alleen bedoeld voor controledoeleinden en het abonnement is niet automatisch verlopen. De levenscyclus van het abonnement kan worden beheerd met behulp van de |
properties.ownerId |
string |
Pad naar gebruikers-id: /users/{userId} |
properties.primaryKey |
string |
Primaire abonnementssleutel. |
properties.scope |
string |
Bereik zoals /products/{productId} of /apis of /apis/{apiId} |
properties.secondaryKey |
string |
Secundaire abonnementssleutel. |
properties.state |
Abonnementsstatus. Mogelijke statussen zijn * actief – het abonnement is actief, * opgeschort – het abonnement is geblokkeerd en de abonnee kan geen API's van het product aanroepen, * ingediend – de abonnementsaanvraag is gedaan door de ontwikkelaar, maar is nog niet goedgekeurd of afgewezen, * geweigerd – de abonnementsaanvraag is geweigerd door een beheerder, * geannuleerd – het abonnement is geannuleerd door de ontwikkelaar of beheerder, * verlopen: het abonnement heeft de vervaldatum bereikt en is gedeactiveerd. |
|
properties.stateComment |
string |
Opmerkingen over het wijzigen van de abonnementsstatus door de beheerder wanneer de status wordt gewijzigd in 'geweigerd'. |