Subscription - Update

Service:

API Management

API-versie:

2021-08-01

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=2021-08-01

Met optionele parameters:

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}?notify={notify}&api-version=2021-08-01&appType={appType}

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep.
serviceName	path	True	string	De naam van de API Management service. Regex-patroon: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
sid	path	True	string	Id van abonnementsentiteit. De entiteit vertegenwoordigt de koppeling tussen een gebruiker en een product in API Management. Regex-patroon: ^[^*#&+:<>?]+$
subscriptionId	path	True	string	Abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.
api-version	query	True	string	Versie van de API die moet worden gebruikt met de clientaanvraag.
appType	query		AppType	Bepaalt het type toepassing dat de aanvraag voor het maken van de gebruiker verzendt. De standaardinstelling is de verouderde uitgeversportal.
notify	query		boolean	Wijziging melden in Abonnementsstatus. Indien onwaar, stuur dan geen e-mailmelding voor wijziging van de status van het abonnement Als dit waar is, verzendt u een e-mailmelding over de wijziging van de status van het abonnement

Aanvraagkoptekst

Name	Vereist	Type	Description
If-Match	True	string	ETag van de entiteit. ETag moet overeenkomen met de huidige entiteitsstatus uit de headerreactie 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 state eigenschap . De datum voldoet aan de volgende notatie: yyyy-MM-ddTHH:mm:ssZ zoals opgegeven door de ISO 8601-standaard.
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	SubscriptionState	Abonnementsstatus. Mogelijke statussen zijn * actief – het abonnement is actief, * opgeschort – het abonnement wordt 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	SubscriptionContract	De abonnementsgegevens zijn bijgewerkt. Kopteksten ETag: string
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementUpdateSubscription

Voorbeeldaanvraag

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub?api-version=2021-08-01


{
  "properties": {
    "displayName": "testsub"
  }
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.apimanagement.models.SubscriptionUpdateParameters;

/** Samples for Subscription Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateSubscription.json
     */
    /**
     * Sample code: ApiManagementUpdateSubscription.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementUpdateSubscription(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .subscriptions()
            .updateWithResponse(
                "rg1",
                "apimService1",
                "testsub",
                "*",
                new SubscriptionUpdateParameters().withDisplayName("testsub"),
                null,
                null,
                Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_update_subscription.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.subscription.update(
        resource_group_name="rg1",
        service_name="apimService1",
        sid="testsub",
        if_match="*",
        parameters={"properties": {"displayName": "testsub"}},
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateSubscription.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateSubscription.json
func ExampleSubscriptionClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSubscriptionClient().Update(ctx, "rg1", "apimService1", "testsub", "*", armapimanagement.SubscriptionUpdateParameters{
		Properties: &armapimanagement.SubscriptionUpdateParameterProperties{
			DisplayName: to.Ptr("testsub"),
		},
	}, &armapimanagement.SubscriptionClientUpdateOptions{Notify: nil,
		AppType: nil,
	})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SubscriptionContract = armapimanagement.SubscriptionContract{
	// 	Name: to.Ptr("testsub"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/subscriptions"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub"),
	// 	Properties: &armapimanagement.SubscriptionContractProperties{
	// 		CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-06-02T17:59:06.223Z"); return t}()),
	// 		DisplayName: to.Ptr("testsub"),
	// 		OwnerID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b"),
	// 		Scope: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002"),
	// 		State: to.Ptr(armapimanagement.SubscriptionStateSubmitted),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Updates the details of a subscription specified by its identifier.
 *
 * @summary Updates the details of a subscription specified by its identifier.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateSubscription.json
 */
async function apiManagementUpdateSubscription() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const sid = "testsub";
  const ifMatch = "*";
  const parameters = { displayName: "testsub" };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.subscription.update(
    resourceGroupName,
    serviceName,
    sid,
    ifMatch,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ApiManagement;
using Azure.ResourceManager.ApiManagement.Models;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateSubscription.json
// this example is just showing the usage of "Subscription_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementSubscriptionResource created on azure
// for more information of creating ApiManagementSubscriptionResource, please refer to the document of ApiManagementSubscriptionResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string sid = "testsub";
ResourceIdentifier apiManagementSubscriptionResourceId = ApiManagementSubscriptionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, sid);
ApiManagementSubscriptionResource apiManagementSubscription = client.GetApiManagementSubscriptionResource(apiManagementSubscriptionResourceId);

// invoke the operation
ETag ifMatch = new ETag("*");
ApiManagementSubscriptionPatch patch = new ApiManagementSubscriptionPatch()
{
    DisplayName = "testsub",
};
ApiManagementSubscriptionResource result = await apiManagementSubscription.UpdateAsync(ifMatch, patch);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SubscriptionContractData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Voorbeeldrespons

Statuscode:

200

{
  "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
AppType	Bepaalt het type toepassing dat de aanvraag voor het maken van de gebruiker verzendt. De standaardinstelling is de verouderde uitgeversportal.
ErrorFieldContract	Fout veldcontract.
ErrorResponse	Foutreactie.
SubscriptionContract	Abonnementsgegevens.
SubscriptionState	Abonnementsstatus. Mogelijke statussen zijn * actief – het abonnement is actief, * opgeschort – het abonnement wordt 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.
SubscriptionUpdateParameters	Details van abonnementsupdate.

AppType

Bepaalt het type toepassing dat de aanvraag voor het maken van de gebruiker verzendt. De standaardinstelling is de verouderde uitgeversportal.

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 via 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	ErrorFieldContract[]	De lijst met ongeldige velden verzenden in aanvraag, in 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. Bijvoorbeeld - /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: yyyy-MM-ddTHH:mm:ssZ zoals opgegeven door de ISO 8601-standaard.
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 state eigenschap . De datum voldoet aan de volgende notatie: yyyy-MM-ddTHH:mm:ssZ zoals opgegeven door de ISO 8601-standaard.
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 state eigenschap . De datum voldoet aan de volgende notatie: yyyy-MM-ddTHH:mm:ssZ zoals opgegeven door de ISO 8601-standaard.
properties.notificationDate	string	Aankomende vervaldatum van abonnement. De datum voldoet aan de volgende notatie: yyyy-MM-ddTHH:mm:ssZ zoals opgegeven door de ISO 8601-standaard.
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 voor '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 voor 'GET'-bewerkingen! Gebruik post-aanvraag '/listSecrets' om de waarde op te halen.
properties.startDate	string	Activeringsdatum van het 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 state eigenschap . De datum voldoet aan de volgende notatie: yyyy-MM-ddTHH:mm:ssZ zoals opgegeven door de ISO 8601-standaard.
properties.state	SubscriptionState	Abonnementsstatus. Mogelijke statussen zijn * actief – het abonnement is actief, * opgeschort – het abonnement wordt 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 abonnementscommentaar toegevoegd door een beheerder wanneer de status wordt gewijzigd in '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 wordt 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 abonnementsupdate.

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 state eigenschap . De datum voldoet aan de volgende notatie: yyyy-MM-ddTHH:mm:ssZ zoals opgegeven door de ISO 8601-standaard.
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	SubscriptionState	Abonnementsstatus. Mogelijke statussen zijn * actief – het abonnement is actief, * opgeschort – het abonnement wordt 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'.