Subscription - Create Or Update

Service:

API Management

API Version:

2022-08-01

Membuat atau memperbarui langganan pengguna tertentu ke produk tertentu.

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}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resourceGroupName	path	True	string	Nama grup sumber daya. Nama tidak peka huruf besar/kecil.
serviceName	path	True	string	Nama layanan API Management. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
sid	path	True	string	Pengidentifikasi entitas langganan. Entitas mewakili hubungan antara pengguna dan produk dalam API Management. Regex pattern: ^[^*#&+:<>?]+$
subscriptionId	path	True	string	ID langganan target.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.
appType	query		AppType	Menentukan jenis aplikasi yang mengirim permintaan buat pengguna. Defaultnya adalah portal penerbit warisan.
notify	query		boolean	Beri tahu perubahan dalam Status Langganan. Jika false, jangan kirim pemberitahuan email apa pun untuk perubahan status langganan Jika true, kirim pemberitahuan email tentang perubahan status langganan

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
If-Match		string	ETag Entitas. Tidak diperlukan saat membuat entitas, tetapi diperlukan saat memperbarui entitas.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
properties.displayName	True	string	Nama langganan.
properties.scope	True	string	Cakupan seperti /products/{productId} atau /apis atau /apis/{apiId}.
properties.allowTracing		boolean	Menentukan apakah pelacakan dapat diaktifkan
properties.ownerId		string	Pengguna (jalur id pengguna) yang langganannya sedang dibuat dalam formulir /users/{userId}
properties.primaryKey		string	Kunci langganan utama. Jika tidak ditentukan selama kunci permintaan akan dibuat secara otomatis.
properties.secondaryKey		string	Kunci langganan sekunder. Jika tidak ditentukan selama kunci permintaan akan dibuat secara otomatis.
properties.state		SubscriptionState	Status langganan awal. Jika tidak ada nilai yang ditentukan, langganan dibuat dengan status Dikirim. Status yang mungkin * aktif - langganan aktif, * ditangguhkan - langganan diblokir, dan pelanggan tidak dapat memanggil API produk apa pun, * dikirimkan - permintaan langganan telah dibuat oleh pengembang, tetapi belum disetujui atau ditolak, * ditolak - permintaan langganan telah ditolak oleh administrator, * dibatalkan - langganan telah dibatalkan oleh pengembang atau administrator, * kedaluwarsa – langganan mencapai tanggal kedaluwarsa dan dinonaktifkan.

Respons

Nama	Jenis	Deskripsi
200 OK	SubscriptionContract	Pengguna sudah berlangganan produk. Headers ETag: string
201 Created	SubscriptionContract	Pengguna berhasil berlangganan produk. Headers ETag: string
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

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

Definisi

Nama	Deskripsi
AppType	Menentukan jenis aplikasi yang mengirim permintaan buat pengguna. Defaultnya adalah portal penerbit warisan.
ErrorFieldContract	Kontrak Bidang Kesalahan.
ErrorResponse	Respons Kesalahan.
SubscriptionContract	Detail langganan.
SubscriptionCreateParameters	Detail pembuatan langganan.
SubscriptionState	Status langganan. Status yang mungkin * aktif - langganan aktif, * ditangguhkan - langganan diblokir, dan pelanggan tidak dapat memanggil API produk apa pun, * dikirimkan - permintaan langganan telah dibuat oleh pengembang, tetapi belum disetujui atau ditolak, * ditolak - permintaan langganan telah ditolak oleh administrator, * dibatalkan - langganan telah dibatalkan oleh pengembang atau administrator, * kedaluwarsa – langganan mencapai tanggal kedaluwarsa dan dinonaktifkan.

AppType

Menentukan jenis aplikasi yang mengirim permintaan buat pengguna. Defaultnya adalah portal penerbit warisan.

Nama	Jenis	Deskripsi
developerPortal	string	Permintaan pembuatan pengguna dikirim oleh portal pengembang baru.
portal	string	Permintaan pembuatan pengguna dikirim oleh portal pengembang warisan.

ErrorFieldContract

Kontrak Bidang Kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan tingkat properti.
message	string	Representasi kesalahan tingkat properti yang dapat dibaca manusia.
target	string	Nama properti.

ErrorResponse

Respons Kesalahan.

Nama	Jenis	Deskripsi
error.code	string	Kode kesalahan yang ditentukan layanan. Kode ini berfungsi sebagai sub-status untuk kode kesalahan HTTP yang ditentukan dalam respons.
error.details	ErrorFieldContract[]	Daftar bidang yang tidak valid dikirim dalam permintaan, jika terjadi kesalahan validasi.
error.message	string	Representasi kesalahan yang dapat dibaca manusia.

SubscriptionContract

Detail langganan.

Nama	Jenis	Deskripsi
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nama sumber daya.
properties.allowTracing	boolean	Menentukan apakah pelacakan diaktifkan
properties.createdDate	string	Tanggal pembuatan langganan. Tanggal sesuai dengan format berikut: yyyy-MM-ddTHH:mm:ssZ seperti yang ditentukan oleh standar ISO 8601.
properties.displayName	string	Nama langganan, atau null jika langganan tidak memiliki nama.
properties.endDate	string	Tanggal saat langganan dibatalkan atau kedaluwarsa. Pengaturannya hanya untuk tujuan audit dan langganan tidak dibatalkan secara otomatis. Siklus hidup langganan dapat dikelola dengan menggunakan state properti . Tanggal sesuai dengan format berikut: yyyy-MM-ddTHH:mm:ssZ seperti yang ditentukan oleh standar ISO 8601.
properties.expirationDate	string	Tanggal kedaluwarsa langganan. Pengaturannya hanya untuk tujuan audit dan langganan tidak kedaluwarsa secara otomatis. Siklus hidup langganan dapat dikelola dengan menggunakan state properti . Tanggal sesuai dengan format berikut: yyyy-MM-ddTHH:mm:ssZ seperti yang ditentukan oleh standar ISO 8601.
properties.notificationDate	string	Tanggal pemberitahuan kedaluwarsa langganan mendatang. Tanggal sesuai dengan format berikut: yyyy-MM-ddTHH:mm:ssZ seperti yang ditentukan oleh standar ISO 8601.
properties.ownerId	string	Pengidentifikasi sumber daya pengguna pemilik langganan. Nilai adalah URL relatif yang valid dalam format /users/{userId} di mana {userId} adalah pengidentifikasi pengguna.
properties.primaryKey	string	Kunci utama langganan. Properti ini tidak akan diisi pada operasi 'GET'! Gunakan permintaan POST '/listSecrets' untuk mendapatkan nilainya.
properties.scope	string	Cakupan seperti /products/{productId} atau /apis atau /apis/{apiId}.
properties.secondaryKey	string	Kunci sekunder langganan. Properti ini tidak akan diisi pada operasi 'GET'! Gunakan permintaan POST '/listSecrets' untuk mendapatkan nilainya.
properties.startDate	string	Tanggal aktivasi langganan. Pengaturan hanya untuk tujuan audit dan langganan tidak diaktifkan secara otomatis. Siklus hidup langganan dapat dikelola dengan menggunakan state properti . Tanggal sesuai dengan format berikut: yyyy-MM-ddTHH:mm:ssZ seperti yang ditentukan oleh standar ISO 8601.
properties.state	SubscriptionState	Status langganan. Status yang mungkin * aktif - langganan aktif, * ditangguhkan - langganan diblokir, dan pelanggan tidak dapat memanggil API produk apa pun, * dikirimkan - permintaan langganan telah dibuat oleh pengembang, tetapi belum disetujui atau ditolak, * ditolak - permintaan langganan telah ditolak oleh administrator, * dibatalkan - langganan telah dibatalkan oleh pengembang atau administrator, * kedaluwarsa – langganan mencapai tanggal kedaluwarsa dan dinonaktifkan.
properties.stateComment	string	Komentar langganan opsional ditambahkan oleh administrator saat status diubah menjadi 'ditolak'.
type	string	Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

SubscriptionCreateParameters

Detail pembuatan langganan.

Nama	Jenis	Deskripsi
properties.allowTracing	boolean	Menentukan apakah pelacakan dapat diaktifkan
properties.displayName	string	Nama langganan.
properties.ownerId	string	Pengguna (jalur id pengguna) yang langganannya sedang dibuat dalam formulir /users/{userId}
properties.primaryKey	string	Kunci langganan utama. Jika tidak ditentukan selama kunci permintaan akan dibuat secara otomatis.
properties.scope	string	Cakupan seperti /products/{productId} atau /apis atau /apis/{apiId}.
properties.secondaryKey	string	Kunci langganan sekunder. Jika tidak ditentukan selama kunci permintaan akan dibuat secara otomatis.
properties.state	SubscriptionState	Status langganan awal. Jika tidak ada nilai yang ditentukan, langganan dibuat dengan status Dikirim. Status yang mungkin * aktif - langganan aktif, * ditangguhkan - langganan diblokir, dan pelanggan tidak dapat memanggil API produk apa pun, * dikirimkan - permintaan langganan telah dibuat oleh pengembang, tetapi belum disetujui atau ditolak, * ditolak - permintaan langganan telah ditolak oleh administrator, * dibatalkan - langganan telah dibatalkan oleh pengembang atau administrator, * kedaluwarsa – langganan mencapai tanggal kedaluwarsa dan dinonaktifkan.

SubscriptionState

Status langganan. Status yang mungkin * aktif - langganan aktif, * ditangguhkan - langganan diblokir, dan pelanggan tidak dapat memanggil API produk apa pun, * dikirimkan - permintaan langganan telah dibuat oleh pengembang, tetapi belum disetujui atau ditolak, * ditolak - permintaan langganan telah ditolak oleh administrator, * dibatalkan - langganan telah dibatalkan oleh pengembang atau administrator, * kedaluwarsa – langganan mencapai tanggal kedaluwarsa dan dinonaktifkan.

Nama	Jenis	Deskripsi
active	string
cancelled	string
expired	string
rejected	string
submitted	string
suspended	string