Subscription - Create Or Update

Service:

API Management

API Version:

2022-08-01

Létrehozza vagy frissíti a megadott felhasználó előfizetését a megadott termékre.

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

With optional parameters:

PUT 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-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string	Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket.
serviceName	path	True	string	A API Management szolgáltatás neve. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
sid	path	True	string	Előfizetés entitásazonosítója. Az entitás egy felhasználó és egy termék közötti társítást jelöli a API Management. Regex pattern: ^[^*#&+:<>?]+$
subscriptionId	path	True	string	A cél-előfizetés azonosítója.
api-version	query	True	string	A művelethez használandó API-verzió.
appType	query		AppType	Meghatározza, hogy milyen típusú alkalmazás küldi el a létrehozási felhasználói kérést. Az alapértelmezett érték az örökölt közzétevői portál.
notify	query		boolean	Értesítés az előfizetés állapotának változásáról. Ha hamis, ne küldjön e-mailben értesítést az előfizetés állapotának módosításáról Ha igaz, küldjön e-mailt az előfizetés állapotának változásáról

Kérelem fejléce

Name	Kötelező	Típus	Description
If-Match		string	Az entitás ETagje. Entitás létrehozásakor nem kötelező, de az entitások frissítésekor szükséges.

Kérelem törzse

Name	Kötelező	Típus	Description
properties.displayName	True	string	Előfizetés neve.
properties.scope	True	string	Hatókör, például /products/{productId} vagy /apis vagy /apis/{apiId}.
properties.allowTracing		boolean	Meghatározza, hogy engedélyezhető-e a nyomkövetés
properties.ownerId		string	Felhasználó (felhasználói azonosító elérési útja), akinek az előfizetését a /users/{userId} űrlapon hozza létre
properties.primaryKey		string	Elsődleges előfizetési kulcs. Ha a kérés során nincs megadva, a rendszer automatikusan létrehozza a kulcsot.
properties.secondaryKey		string	Másodlagos előfizetési kulcs. Ha a kérés során nincs megadva, a rendszer automatikusan létrehozza a kulcsot.
properties.state		SubscriptionState	Kezdeti előfizetési állapot. Ha nincs megadva érték, az előfizetés Elküldve állapottal jön létre. Lehetséges állapotok * aktív – az előfizetés aktív, * felfüggesztve – az előfizetés le van tiltva, és az előfizető nem hívhatja meg a termék api-jait, * elküldve – az előfizetési kérelmet a fejlesztő tette meg, de még nem hagyta jóvá vagy nem utasította el, * elutasítva – az előfizetési kérelmet egy rendszergazda elutasította, * lemondta – az előfizetést a fejlesztő vagy a rendszergazda törölte, * lejárt – az előfizetés elérte a lejárati dátumát, és inaktiválta.

Válaszok

Name	Típus	Description
200 OK	SubscriptionContract	A felhasználó már feliratkozott a termékre. Headers ETag: string
201 Created	SubscriptionContract	A felhasználó sikeresen feliratkozott a termékre. Headers ETag: string
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

ApiManagementCreateSubscription

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub?api-version=2022-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.resourcemanager.apimanagement.models.SubscriptionCreateParameters;

/** Samples for Subscription CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-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,
                com.azure.core.util.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 typing import Any, IO, Union

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/2022-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/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-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.105Z"); 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/2022-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

Sample Response

Status code:

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"
  }
}

Status code:

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"
  }
}

Definíciók

Name	Description
AppType	Meghatározza, hogy milyen típusú alkalmazás küldi el a létrehozási felhasználói kérést. Az alapértelmezett érték az örökölt közzétevői portál.
ErrorFieldContract	Hibamező-szerződés.
ErrorResponse	Hibaválasz.
SubscriptionContract	Előfizetés részletei.
SubscriptionCreateParameters	Az előfizetés létrehozási részletei.
SubscriptionState	Előfizetés állapota. Lehetséges állapotok * aktív – az előfizetés aktív, * felfüggesztve – az előfizetés le van tiltva, és az előfizető nem hívhatja meg a termék api-jait, * elküldve – az előfizetési kérelmet a fejlesztő tette meg, de még nem hagyta jóvá vagy nem utasította el, * elutasítva – az előfizetési kérelmet egy rendszergazda elutasította, * lemondta – az előfizetést a fejlesztő vagy a rendszergazda törölte, * lejárt – az előfizetés elérte a lejárati dátumát, és inaktiválta.

AppType

Meghatározza, hogy milyen típusú alkalmazás küldi el a létrehozási felhasználói kérést. Az alapértelmezett érték az örökölt közzétevői portál.

Name	Típus	Description
developerPortal	string	A felhasználói létrehozási kérést az új fejlesztői portál küldte el.
portal	string	A felhasználói létrehozási kérést az örökölt fejlesztői portál küldte el.

ErrorFieldContract

Hibamező-szerződés.

Name	Típus	Description
code	string	Tulajdonságszintű hibakód.
message	string	A tulajdonságszintű hiba emberi olvasásra alkalmas ábrázolása.
target	string	Tulajdonság neve.

ErrorResponse

Hibaválasz.

Name	Típus	Description
error.code	string	Szolgáltatás által definiált hibakód. Ez a kód a válaszban megadott HTTP-hibakód alállapotaként szolgál.
error.details	ErrorFieldContract[]	Érvényesítési hiba esetén az érvénytelen mezők listája küldi el a kérést.
error.message	string	A hiba emberi olvasásra alkalmas ábrázolása.

SubscriptionContract

Előfizetés részletei.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties.allowTracing	boolean	Meghatározza, hogy engedélyezve van-e a nyomkövetés
properties.createdDate	string	Előfizetés létrehozásának dátuma. A dátum az ISO 8601 szabványban megadott formátumnak yyyy-MM-ddTHH:mm:ssZ felel meg.
properties.displayName	string	Az előfizetés neve, vagy null értékű, ha az előfizetésnek nincs neve.
properties.endDate	string	Az előfizetés lemondásának vagy lejártának dátuma. A beállítás csak naplózási célokat szolgál, és az előfizetés nem törlődik automatikusan. Az előfizetés életciklusa a state tulajdonság használatával kezelhető. A dátum az ISO 8601 szabványban megadott formátumnak yyyy-MM-ddTHH:mm:ssZ felel meg.
properties.expirationDate	string	Előfizetés lejárati dátuma. A beállítás csak naplózási célokat szolgál, és az előfizetés nem járt le automatikusan. Az előfizetés életciklusa a state tulajdonság használatával kezelhető. A dátum az ISO 8601 szabványban megadott formátumnak yyyy-MM-ddTHH:mm:ssZ felel meg.
properties.notificationDate	string	Az előfizetés lejáratának közelgő értesítési dátuma. A dátum az ISO 8601 szabványban megadott formátumnak yyyy-MM-ddTHH:mm:ssZ felel meg.
properties.ownerId	string	Az előfizetés tulajdonosának felhasználói erőforrás-azonosítója. Az érték egy érvényes relatív URL-cím /users/{userId} formátumban, ahol a(z) {userId} egy felhasználói azonosító.
properties.primaryKey	string	Előfizetés elsődleges kulcsa. Ez a tulajdonság nem lesz kitöltve a GET műveletekben! Az érték lekéréséhez használja a "/listSecrets" POST kérést.
properties.scope	string	Hatókör, például /products/{productId} vagy /apis vagy /apis/{apiId}.
properties.secondaryKey	string	Előfizetés másodlagos kulcsa. Ez a tulajdonság nem lesz kitöltve a GET műveletekben! Az érték lekéréséhez használja a "/listSecrets" POST kérést.
properties.startDate	string	Előfizetés aktiválásának dátuma. A beállítás csak naplózási célokat szolgál, és az előfizetés nem aktiválódik automatikusan. Az előfizetés életciklusa a state tulajdonság használatával kezelhető. A dátum az ISO 8601 szabványban megadott formátumnak yyyy-MM-ddTHH:mm:ssZ felel meg.
properties.state	SubscriptionState	Előfizetés állapota. Lehetséges állapotok * aktív – az előfizetés aktív, * felfüggesztve – az előfizetés le van tiltva, és az előfizető nem hívhatja meg a termék api-jait, * elküldve – az előfizetési kérelmet a fejlesztő tette meg, de még nem hagyta jóvá vagy nem utasította el, * elutasítva – az előfizetési kérelmet egy rendszergazda elutasította, * lemondta – az előfizetést a fejlesztő vagy a rendszergazda törölte, * lejárt – az előfizetés elérte a lejárati dátumát, és inaktiválta.
properties.stateComment	string	A rendszergazda nem kötelező előfizetési megjegyzést adott hozzá, amikor az állapot "elutasítva" állapotra módosul.
type	string	Az erőforrás típusa. Például "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

SubscriptionCreateParameters

Az előfizetés létrehozási részletei.

Name	Típus	Description
properties.allowTracing	boolean	Meghatározza, hogy engedélyezhető-e a nyomkövetés
properties.displayName	string	Előfizetés neve.
properties.ownerId	string	Felhasználó (felhasználói azonosító elérési útja), akinek az előfizetését a /users/{userId} űrlapon hozza létre
properties.primaryKey	string	Elsődleges előfizetési kulcs. Ha a kérés során nincs megadva, a rendszer automatikusan létrehozza a kulcsot.
properties.scope	string	Hatókör, például /products/{productId} vagy /apis vagy /apis/{apiId}.
properties.secondaryKey	string	Másodlagos előfizetési kulcs. Ha a kérés során nincs megadva, a rendszer automatikusan létrehozza a kulcsot.
properties.state	SubscriptionState	Kezdeti előfizetési állapot. Ha nincs megadva érték, az előfizetés Elküldve állapottal jön létre. Lehetséges állapotok * aktív – az előfizetés aktív, * felfüggesztve – az előfizetés le van tiltva, és az előfizető nem hívhatja meg a termék api-jait, * elküldve – az előfizetési kérelmet a fejlesztő tette meg, de még nem hagyta jóvá vagy nem utasította el, * elutasítva – az előfizetési kérelmet egy rendszergazda elutasította, * lemondta – az előfizetést a fejlesztő vagy a rendszergazda törölte, * lejárt – az előfizetés elérte a lejárati dátumát, és inaktiválta.

SubscriptionState

Előfizetés állapota. Lehetséges állapotok * aktív – az előfizetés aktív, * felfüggesztve – az előfizetés le van tiltva, és az előfizető nem hívhatja meg a termék api-jait, * elküldve – az előfizetési kérelmet a fejlesztő tette meg, de még nem hagyta jóvá vagy nem utasította el, * elutasítva – az előfizetési kérelmet egy rendszergazda elutasította, * lemondta – az előfizetést a fejlesztő vagy a rendszergazda törölte, * lejárt – az előfizetés elérte a lejárati dátumát, és inaktiválta.

Name	Típus	Description
active	string
cancelled	string
expired	string
rejected	string
submitted	string
suspended	string