Subscription - Create Or Update

Referensi

Service:: API Management

API Version:: 2021-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=2021-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=2021-08-01&appType={appType}

Parameter URI

Name	In	Required	Type	Description
resourceGroupName	path	True	string	Nama grup sumber daya.
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	Kredensial langganan yang secara unik mengidentifikasi langganan Microsoft Azure. ID langganan membentuk bagian dari URI untuk setiap panggilan layanan.
api-version	query	True	string	Versi API yang akan digunakan dengan permintaan klien.
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

Name	Required	Type	Description
If-Match		string	ETag Entitas. Tidak diperlukan saat membuat entitas, tetapi diperlukan saat memperbarui entitas.

Isi Permintaan

Name	Required	Type	Description
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 bentuk /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 Dikirimkan. 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

Name	Type	Description
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.

Name

Type

Description

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

Azure Active Directory Flow OAuth2.

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

Scopes

Name	Description
user_impersonation	meniru akun pengguna Anda

Contoh

ApiManagementCreateSubscription

Sample Request

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

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);
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

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/tree/main/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()
	client, err := armapimanagement.NewSubscriptionClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.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)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

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

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.

Name	Type	Description
developerPortal	string	Permintaan pembuatan pengguna dikirim oleh portal pengembang baru.
portal	string	Permintaan pembuatan pengguna dikirim oleh portal pengembang warisan.

ErrorFieldContract

Kontrak Bidang Kesalahan.

Name	Type	Description
code	string	Kode kesalahan tingkat properti.
message	string	Representasi kesalahan tingkat properti yang dapat dibaca manusia.
target	string	Nama properti.

ErrorResponse

Respons Kesalahan.

Name	Type	Description
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.

Name	Type	Description
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. Pengaturan ini 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. Pengaturan ini 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 dari pemilik langganan. Nilai adalah URL relatif yang valid dalam format /users/{userId} di mana {userId} adalah pengidentifikasi pengguna.
properties.primaryKey	string	Kunci primer 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 ini 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.

Name	Type	Description
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 bentuk /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 Dikirimkan. 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.

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