Subscription - Create Or Update

Service:

API Management

API Version:

2022-08-01

Vytvoří nebo aktualizuje předplatné zadaného uživatele na zadaný produkt.

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}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
serviceName	path	True	string	Název služby API Management. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
sid	path	True	string	Identifikátor entity předplatného. Entita představuje přidružení mezi uživatelem a produktem v API Management. Regex pattern: ^[^*#&+:<>?]+$
subscriptionId	path	True	string	ID cílového předplatného.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.
appType	query		AppType	Určuje typ aplikace, která odesílá žádost uživatele o vytvoření. Výchozí je starší verze portálu vydavatele.
notify	query		boolean	Upozornit na změnu stavu předplatného. Pokud je false, neodesílejte žádné e-mailové oznámení o změně stavu předplatného. Pokud ano, odešlete e-mailové oznámení o změně stavu předplatného.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
If-Match		string	Značka ETag entity. Nevyžaduje se při vytváření entity, ale vyžaduje se při aktualizaci entity.

Text požadavku

Name	Vyžadováno	Typ	Description
properties.displayName	True	string	Název předplatného.
properties.scope	True	string	Rozsah, jako je /products/{productId} nebo /apis nebo /apis/{apiId}.
properties.allowTracing		boolean	Určuje, jestli je možné povolit trasování.
properties.ownerId		string	Uživatel (cesta id uživatele), pro kterého se vytváří předplatné ve formátu /users/{userId}
properties.primaryKey		string	Primární klíč předplatného. Pokud není klíč požadavku zadán, vygeneruje se automaticky.
properties.secondaryKey		string	Sekundární klíč předplatného. Pokud není klíč požadavku zadán, vygeneruje se automaticky.
properties.state		SubscriptionState	Počáteční stav předplatného. Pokud není zadána žádná hodnota, vytvoří se předplatné se stavem Odesláno. Možné stavy jsou * aktivní – předplatné je aktivní, * pozastaveno – předplatné je zablokované a předplatitel nemůže volat žádná rozhraní API produktu, * odesláno – žádost o předplatné byla podána vývojářem, ale ještě nebyla schválena nebo zamítnuta, * zamítnuta – žádost o předplatné byla zamítnuta správcem, * zrušena – předplatné bylo zrušeno vývojářem nebo správcem, * Vypršela – předplatné dosáhlo data vypršení platnosti a bylo deaktivováno.

Odpovědi

Name	Typ	Description
200 OK	SubscriptionContract	Uživatel se již přihlásil k odběru produktu. Headers ETag: string
201 Created	SubscriptionContract	Uživatel se úspěšně přihlásil k odběru produktu. Headers ETag: string
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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

Definice

Name	Description
AppType	Určuje typ aplikace, která odesílá žádost uživatele o vytvoření. Výchozí je starší verze portálu vydavatele.
ErrorFieldContract	Chyba Kontrakt pole.
ErrorResponse	Odpověď na chybu.
SubscriptionContract	Podrobnosti o předplatném.
SubscriptionCreateParameters	Podrobnosti o vytvoření předplatného
SubscriptionState	Stav předplatného. Možné stavy jsou * aktivní – předplatné je aktivní, * pozastaveno – předplatné je zablokované a předplatitel nemůže volat žádná rozhraní API produktu, * odesláno – žádost o předplatné byla podána vývojářem, ale ještě nebyla schválena nebo zamítnuta, * zamítnuta – žádost o předplatné byla zamítnuta správcem, * zrušena – předplatné bylo zrušeno vývojářem nebo správcem, * Vypršela – předplatné dosáhlo data vypršení platnosti a bylo deaktivováno.

AppType

Určuje typ aplikace, která odesílá žádost uživatele o vytvoření. Výchozí je starší verze portálu vydavatele.

Name	Typ	Description
developerPortal	string	Žádost o vytvoření uživatele byla odeslána novým portálem pro vývojáře.
portal	string	Starší verze portálu pro vývojáře odeslala žádost o vytvoření uživatele.

ErrorFieldContract

Chyba Kontrakt pole.

Name	Typ	Description
code	string	Kód chyby na úrovni vlastnosti.
message	string	Čitelné znázornění chyby na úrovni vlastností.
target	string	Název vlastnosti.

ErrorResponse

Odpověď na chybu.

Name	Typ	Description
error.code	string	Kód chyby definované službou Tento kód slouží jako dílčí stav pro kód chyby HTTP zadaný v odpovědi.
error.details	ErrorFieldContract[]	Seznam neplatných polí se odešle v žádosti v případě chyby ověření.
error.message	string	Znázornění chyby čitelné pro člověka

SubscriptionContract

Podrobnosti o předplatném.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku. Příklad – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Název prostředku
properties.allowTracing	boolean	Určuje, jestli je povolené trasování.
properties.createdDate	string	Datum vytvoření předplatného. Datum odpovídá následujícímu formátu: yyyy-MM-ddTHH:mm:ssZ podle normy ISO 8601.
properties.displayName	string	Název předplatného nebo null, pokud předplatné nemá žádný název.
properties.endDate	string	Datum zrušení nebo vypršení platnosti předplatného Toto nastavení je jenom pro účely auditu a předplatné se nezruší automaticky. Životní cyklus předplatného je možné spravovat pomocí state vlastnosti . Datum odpovídá následujícímu formátu: yyyy-MM-ddTHH:mm:ssZ podle normy ISO 8601.
properties.expirationDate	string	Datum vypršení platnosti předplatného. Nastavení je jenom pro účely auditu a předplatné automaticky nevypršelo. Životní cyklus předplatného je možné spravovat pomocí state vlastnosti . Datum odpovídá následujícímu formátu: yyyy-MM-ddTHH:mm:ssZ podle normy ISO 8601.
properties.notificationDate	string	Nadcházející datum oznámení o vypršení platnosti předplatného Datum odpovídá následujícímu formátu: yyyy-MM-ddTHH:mm:ssZ podle normy ISO 8601.
properties.ownerId	string	Identifikátor prostředku uživatele vlastníka předplatného. Hodnota je platná relativní adresa URL ve formátu /users/{userId}, kde {userId} je identifikátor uživatele.
properties.primaryKey	string	Primární klíč předplatného. Tato vlastnost nebude vyplněna při operacích GET! K získání hodnoty použijte požadavek POST /listSecrets.
properties.scope	string	Rozsah, jako je /products/{productId} nebo /apis nebo /apis/{apiId}.
properties.secondaryKey	string	Sekundární klíč předplatného. Tato vlastnost nebude vyplněna při operacích GET! K získání hodnoty použijte požadavek POST /listSecrets.
properties.startDate	string	Datum aktivace předplatného. Toto nastavení je jenom pro účely auditu a předplatné se neaktivuje automaticky. Životní cyklus předplatného je možné spravovat pomocí state vlastnosti . Datum odpovídá následujícímu formátu: yyyy-MM-ddTHH:mm:ssZ podle normy ISO 8601.
properties.state	SubscriptionState	Stav předplatného. Možné stavy jsou * aktivní – předplatné je aktivní, * pozastaveno – předplatné je zablokované a předplatitel nemůže volat žádná rozhraní API produktu, * odesláno – žádost o předplatné byla podána vývojářem, ale ještě nebyla schválena nebo zamítnuta, * zamítnuta – žádost o předplatné byla zamítnuta správcem, * zrušena – předplatné bylo zrušeno vývojářem nebo správcem, * Vypršela – předplatné dosáhlo data vypršení platnosti a bylo deaktivováno.
properties.stateComment	string	Volitelný komentář k předplatnému přidaný správcem, když se stav změní na odmítnuto.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

SubscriptionCreateParameters

Podrobnosti o vytvoření předplatného

Name	Typ	Description
properties.allowTracing	boolean	Určuje, jestli je možné povolit trasování.
properties.displayName	string	Název předplatného.
properties.ownerId	string	Uživatel (cesta id uživatele), pro kterého se vytváří předplatné ve formátu /users/{userId}
properties.primaryKey	string	Primární klíč předplatného. Pokud není klíč požadavku zadán, vygeneruje se automaticky.
properties.scope	string	Rozsah, jako je /products/{productId} nebo /apis nebo /apis/{apiId}.
properties.secondaryKey	string	Sekundární klíč předplatného. Pokud není klíč požadavku zadán, vygeneruje se automaticky.
properties.state	SubscriptionState	Počáteční stav předplatného. Pokud není zadána žádná hodnota, vytvoří se předplatné se stavem Odesláno. Možné stavy jsou * aktivní – předplatné je aktivní, * pozastaveno – předplatné je zablokované a předplatitel nemůže volat žádná rozhraní API produktu, * odesláno – žádost o předplatné byla podána vývojářem, ale ještě nebyla schválena nebo zamítnuta, * zamítnuta – žádost o předplatné byla zamítnuta správcem, * zrušena – předplatné bylo zrušeno vývojářem nebo správcem, * Vypršela – předplatné dosáhlo data vypršení platnosti a bylo deaktivováno.

SubscriptionState

Stav předplatného. Možné stavy jsou * aktivní – předplatné je aktivní, * pozastaveno – předplatné je zablokované a předplatitel nemůže volat žádná rozhraní API produktu, * odesláno – žádost o předplatné byla podána vývojářem, ale ještě nebyla schválena nebo zamítnuta, * zamítnuta – žádost o předplatné byla zamítnuta správcem, * zrušena – předplatné bylo zrušeno vývojářem nebo správcem, * Vypršela – předplatné dosáhlo data vypršení platnosti a bylo deaktivováno.

Name	Typ	Description
active	string
cancelled	string
expired	string
rejected	string
submitted	string
suspended	string