Subscription - Create Or Update

Servizio:

API Management

Versione API:

2021-08-01

Crea o aggiorna la sottoscrizione dell'utente specificato al prodotto specificato.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string	Nome del gruppo di risorse.
serviceName	path	True	string	Nome del servizio di Gestione API. Criterio di espressione regolare: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
sid	path	True	string	Identificatore dell'entità sottoscrizione. L'entità rappresenta l'associazione tra un utente e un prodotto in Gestione API. Criterio di espressione regolare: ^[^*#&+:<>?]+$
subscriptionId	path	True	string	Credenziali di sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.
api-version	query	True	string	Versione dell'API da usare con la richiesta client.
appType	query		AppType	Determina il tipo di applicazione che invia la richiesta di creazione utente. Il valore predefinito è il portale di pubblicazione legacy.
notify	query		boolean	Notifica della modifica nello stato della sottoscrizione. Se false, non inviare alcuna notifica tramite posta elettronica per la modifica dello stato della sottoscrizione Se true, inviare una notifica tramite posta elettronica di modifica dello stato della sottoscrizione

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
If-Match		string	ETag dell'entità. Non obbligatorio durante la creazione di un'entità, ma necessario durante l'aggiornamento di un'entità.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
properties.displayName	True	string	nome della sottoscrizione.
properties.scope	True	string	Ambito come /products/{productId} o /apis o /apis/{apiId}.
properties.allowTracing		boolean	Determina se è possibile abilitare la traccia
properties.ownerId		string	Utente (percorso ID utente) per il quale viene creata la sottoscrizione nel formato /users/{userId}
properties.primaryKey		string	Chiave di sottoscrizione primaria. Se non specificato durante la chiave di richiesta, verrà generato automaticamente.
properties.secondaryKey		string	Chiave di sottoscrizione secondaria. Se non specificato durante la chiave di richiesta, verrà generato automaticamente.
properties.state		SubscriptionState	Stato iniziale della sottoscrizione. Se non viene specificato alcun valore, la sottoscrizione viene creata con stato Inviato. Gli stati possibili sono * attivi: la sottoscrizione è attiva, * sospesa - la sottoscrizione è bloccata e il sottoscrittore non può chiamare alcuna API del prodotto, * inviata - la richiesta di sottoscrizione è stata effettuata dallo sviluppatore, ma non è ancora stata approvata o rifiutata, * rifiutata - la richiesta di sottoscrizione è stata negata da un amministratore, * annullata- la sottoscrizione è stata annullata dallo sviluppatore o dall'amministratore, * Scaduto: la sottoscrizione ha raggiunto la data di scadenza ed è stata disattivata.

Risposte

Nome	Tipo	Descrizione
200 OK	SubscriptionContract	L'utente ha già sottoscritto il prodotto. Intestazioni ETag: string
201 Created	SubscriptionContract	L'utente ha sottoscritto il prodotto. Intestazioni ETag: string
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ApiManagementCreateSubscription

Esempio di richiesta

HTTP

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

{
  "properties": {
    "ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
    "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002",
    "displayName": "testsub"
  }
}

Java

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

/** Samples for Subscription CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementCreateSubscription.json
     */
    /**
     * Sample code: ApiManagementCreateSubscription.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementCreateSubscription(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .subscriptions()
            .createOrUpdateWithResponse(
                "rg1",
                "apimService1",
                "testsub",
                new SubscriptionCreateParameters()
                    .withOwnerId(
                        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7")
                    .withScope(
                        "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002")
                    .withDisplayName("testsub"),
                null,
                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_create_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.create_or_update(
        resource_group_name="rg1",
        service_name="apimService1",
        sid="testsub",
        parameters={
            "properties": {
                "displayName": "testsub",
                "ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
                "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementCreateSubscription.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/ApiManagementCreateSubscription.json
func ExampleSubscriptionClient_CreateOrUpdate() {
	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().CreateOrUpdate(ctx, "rg1", "apimService1", "testsub", armapimanagement.SubscriptionCreateParameters{
		Properties: &armapimanagement.SubscriptionCreateParameterProperties{
			DisplayName: to.Ptr("testsub"),
			OwnerID:     to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7"),
			Scope:       to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002"),
		},
	}, &armapimanagement.SubscriptionClientCreateOrUpdateOptions{Notify: nil,
		IfMatch: 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-02T23:34:03.1055076Z"); return t}()),
	// 		DisplayName: to.Ptr("testsub"),
	// 		OwnerID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7"),
	// 		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 Creates or updates the subscription of specified user to the specified product.
 *
 * @summary Creates or updates the subscription of specified user to the specified product.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementCreateSubscription.json
 */
async function apiManagementCreateSubscription() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const sid = "testsub";
  const parameters = {
    displayName: "testsub",
    ownerId:
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
    scope:
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.subscription.createOrUpdate(
    resourceGroupName,
    serviceName,
    sid,
    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/ApiManagementCreateSubscription.json
// this example is just showing the usage of "Subscription_CreateOrUpdate" 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 ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// get the collection of this ApiManagementSubscriptionResource
ApiManagementSubscriptionCollection collection = apiManagementService.GetApiManagementSubscriptions();

// invoke the operation
string sid = "testsub";
ApiManagementSubscriptionCreateOrUpdateContent content = new ApiManagementSubscriptionCreateOrUpdateContent()
{
    OwnerId = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
    Scope = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002",
    DisplayName = "testsub",
};
ArmOperation<ApiManagementSubscriptionResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, sid, content);
ApiManagementSubscriptionResource result = lro.Value;

// 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

Risposta di esempio

Codice di stato:

201

{
  "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/57127d485157a511ace86ae7",
    "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002",
    "displayName": "testsub",
    "state": "submitted",
    "createdDate": "2017-06-02T23:34:03.1055076Z"
  }
}

Codice di stato:

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/57127d485157a511ace86ae7",
    "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002",
    "displayName": "testsub",
    "state": "submitted",
    "createdDate": "2017-06-02T23:34:03.1055076Z"
  }
}

Definizioni

Nome	Descrizione
AppType	Determina il tipo di applicazione che invia la richiesta di creazione utente. Il valore predefinito è il portale di pubblicazione legacy.
ErrorFieldContract	Contratto campo di errore.
ErrorResponse	Risposta errore.
SubscriptionContract	Dettagli della sottoscrizione.
SubscriptionCreateParameters	Dettagli di creazione della sottoscrizione.
SubscriptionState	Stato della sottoscrizione. Gli stati possibili sono * attivi: la sottoscrizione è attiva, * sospesa - la sottoscrizione è bloccata e il sottoscrittore non può chiamare alcuna API del prodotto, * inviata - la richiesta di sottoscrizione è stata effettuata dallo sviluppatore, ma non è ancora stata approvata o rifiutata, * rifiutata - la richiesta di sottoscrizione è stata negata da un amministratore, * annullata- la sottoscrizione è stata annullata dallo sviluppatore o dall'amministratore, * Scaduto: la sottoscrizione ha raggiunto la data di scadenza ed è stata disattivata.

AppType

Determina il tipo di applicazione che invia la richiesta di creazione utente. Il valore predefinito è il portale di pubblicazione legacy.

Nome	Tipo	Descrizione
developerPortal	string	La richiesta di creazione dell'utente è stata inviata dal nuovo portale per sviluppatori.
portal	string	La richiesta di creazione utente è stata inviata dal portale per sviluppatori legacy.

ErrorFieldContract

Contratto campo di errore.

Nome	Tipo	Descrizione
code	string	Codice di errore a livello di proprietà.
message	string	Rappresentazione leggibile dell'errore a livello di proprietà.
target	string	Nome della proprietà.

ErrorResponse

Risposta errore.

Nome	Tipo	Descrizione
error.code	string	Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta.
error.details	ErrorFieldContract[]	Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida.
error.message	string	Rappresentazione leggibile dell'errore.

SubscriptionContract

Dettagli della sottoscrizione.

Nome	Tipo	Descrizione
id	string	ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	nome della risorsa.
properties.allowTracing	boolean	Determina se la traccia è abilitata
properties.createdDate	string	Data di creazione della sottoscrizione. La data è conforme al formato seguente: yyyy-MM-ddTHH:mm:ssZ come specificato dallo standard ISO 8601.
properties.displayName	string	Nome della sottoscrizione o Null se la sottoscrizione non ha alcun nome.
properties.endDate	string	Data di annullamento o scadenza della sottoscrizione. L'impostazione è solo a scopo di controllo e la sottoscrizione non viene annullata automaticamente. Il ciclo di vita della sottoscrizione può essere gestito usando la state proprietà . La data è conforme al formato seguente: yyyy-MM-ddTHH:mm:ssZ come specificato dallo standard ISO 8601.
properties.expirationDate	string	Data di scadenza della sottoscrizione. L'impostazione è solo a scopo di controllo e la sottoscrizione non è scaduta automaticamente. Il ciclo di vita della sottoscrizione può essere gestito usando la state proprietà . La data è conforme al formato seguente: yyyy-MM-ddTHH:mm:ssZ come specificato dallo standard ISO 8601.
properties.notificationDate	string	Data di notifica di scadenza imminente della sottoscrizione. La data è conforme al formato seguente: yyyy-MM-ddTHH:mm:ssZ come specificato dallo standard ISO 8601.
properties.ownerId	string	Identificatore di risorsa utente del proprietario della sottoscrizione. Il valore è un URL relativo valido nel formato /users/{userId} in cui {userId} è un identificatore utente.
properties.primaryKey	string	Chiave primaria della sottoscrizione. Questa proprietà non verrà compilata nelle operazioni 'GET'. Usare la richiesta POST '/listSecrets' per ottenere il valore.
properties.scope	string	Ambito come /products/{productId} o /apis o /apis/{apiId}.
properties.secondaryKey	string	Chiave secondaria della sottoscrizione. Questa proprietà non verrà compilata nelle operazioni 'GET'. Usare la richiesta POST '/listSecrets' per ottenere il valore.
properties.startDate	string	Data di attivazione della sottoscrizione. L'impostazione è solo a scopo di controllo e la sottoscrizione non viene attivata automaticamente. Il ciclo di vita della sottoscrizione può essere gestito usando la state proprietà . La data è conforme al formato seguente: yyyy-MM-ddTHH:mm:ssZ come specificato dallo standard ISO 8601.
properties.state	SubscriptionState	Stato della sottoscrizione. Gli stati possibili sono * attivi: la sottoscrizione è attiva, * sospesa - la sottoscrizione è bloccata e il sottoscrittore non può chiamare alcuna API del prodotto, * inviata - la richiesta di sottoscrizione è stata effettuata dallo sviluppatore, ma non è ancora stata approvata o rifiutata, * rifiutata - la richiesta di sottoscrizione è stata negata da un amministratore, * annullata- la sottoscrizione è stata annullata dallo sviluppatore o dall'amministratore, * Scaduto: la sottoscrizione ha raggiunto la data di scadenza ed è stata disattivata.
properties.stateComment	string	Commento della sottoscrizione facoltativo aggiunto da un amministratore quando lo stato viene modificato in "rifiutato".
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

SubscriptionCreateParameters

Dettagli di creazione della sottoscrizione.

Nome	Tipo	Descrizione
properties.allowTracing	boolean	Determina se è possibile abilitare la traccia
properties.displayName	string	nome della sottoscrizione.
properties.ownerId	string	Utente (percorso ID utente) per il quale viene creata la sottoscrizione nel formato /users/{userId}
properties.primaryKey	string	Chiave di sottoscrizione primaria. Se non specificato durante la chiave di richiesta, verrà generato automaticamente.
properties.scope	string	Ambito come /products/{productId} o /apis o /apis/{apiId}.
properties.secondaryKey	string	Chiave di sottoscrizione secondaria. Se non specificato durante la chiave di richiesta, verrà generato automaticamente.
properties.state	SubscriptionState	Stato iniziale della sottoscrizione. Se non viene specificato alcun valore, la sottoscrizione viene creata con stato Inviato. Gli stati possibili sono * attivi: la sottoscrizione è attiva, * sospesa - la sottoscrizione è bloccata e il sottoscrittore non può chiamare alcuna API del prodotto, * inviata - la richiesta di sottoscrizione è stata effettuata dallo sviluppatore, ma non è ancora stata approvata o rifiutata, * rifiutata - la richiesta di sottoscrizione è stata negata da un amministratore, * annullata- la sottoscrizione è stata annullata dallo sviluppatore o dall'amministratore, * Scaduto: la sottoscrizione ha raggiunto la data di scadenza ed è stata disattivata.

SubscriptionState

Stato della sottoscrizione. Gli stati possibili sono * attivi: la sottoscrizione è attiva, * sospesa - la sottoscrizione è bloccata e il sottoscrittore non può chiamare alcuna API del prodotto, * inviata - la richiesta di sottoscrizione è stata effettuata dallo sviluppatore, ma non è ancora stata approvata o rifiutata, * rifiutata - la richiesta di sottoscrizione è stata negata da un amministratore, * annullata- la sottoscrizione è stata annullata dallo sviluppatore o dall'amministratore, * Scaduto: la sottoscrizione ha raggiunto la data di scadenza ed è stata disattivata.

Nome	Tipo	Descrizione
active	string
cancelled	string
expired	string
rejected	string
submitted	string
suspended	string