Workspace Subscription - Create Or Update

Hizmet:: API Management

API Sürümü:: 2024-05-01

Belirtilen kullanıcının aboneliğini belirtilen ürüne oluşturur veya güncelleştirir.

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

İsteğe bağlı parametrelerle:

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API Management hizmetinin adı.
sid	path	True	string maxLength: 256 pattern: ^[^*#&+:<>?]+$	Abonelik varlığı Tanımlayıcısı. Varlık, API Management'ta bir kullanıcı ile bir ürün arasındaki ilişkiyi temsil eder.
subscriptionId	path	True	string (uuid)	Hedef aboneliğin kimliği. Değer bir UUID olmalıdır.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Çalışma alanı tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.
appType	query		AppType	Oluşturma kullanıcı isteğini gönderen uygulamanın türünü belirler. Varsayılan, eski yayımcı portalıdır.
notify	query		boolean	Abonelik Durumunda değişikliği bildir. Yanlışsa, aboneliğin durumunu değiştirmek için herhangi bir e-posta bildirimi göndermeyin Doğruysa, abonelik durumunun değiştirilmesine ilişkin e-posta bildirimi gönderin

İstek Başlığı

Name	Gerekli	Tür	Description
If-Match		string	Varlığın ETag'i. Varlık oluştururken gerekli değildir, ancak varlığı güncelleştirirken gereklidir.

İstek Gövdesi

Name	Gerekli	Tür	Description
properties.displayName	True	string minLength: 1 maxLength: 100	Abonelik adı.
properties.scope	True	string	/products/{productId} veya /apis veya /apis/{apiId} gibi kapsam.
properties.allowTracing		boolean	İzlemenin etkinleştirilip etkinleştirilmeyeceğini belirler
properties.ownerId		string	Aboneliğin /users/{userId} biçiminde oluşturulduğu kullanıcı (kullanıcı kimliği yolu)
properties.primaryKey		string minLength: 1 maxLength: 256	Birincil abonelik anahtarı. İstek anahtarı sırasında belirtilmezse otomatik olarak oluşturulur.
properties.secondaryKey		string minLength: 1 maxLength: 256	İkincil abonelik anahtarı. İstek anahtarı sırasında belirtilmezse otomatik olarak oluşturulur.
properties.state		SubscriptionState	İlk abonelik durumu. Herhangi bir değer belirtilmezse, Abonelik Gönderildi durumuyla oluşturulur. Olası durumlar * etkindir – abonelik etkin, * askıya alınmış – abonelik engellenir ve abone ürünün api'lerini çağıramaz, * gönderildi – abonelik isteği geliştirici tarafından yapılmış, ancak henüz onaylanmamış veya reddedilmemiş, * reddedildi – abonelik isteği bir yönetici tarafından reddedildi, * iptal edildi – abonelik geliştirici veya yönetici tarafından iptal edildi, * süresi doldu – abonelik son kullanma tarihine ulaştı ve devre dışı bırakıldı.

Yanıtlar

Name	Tür	Description
200 OK	SubscriptionContract	Kullanıcı ürüne zaten abone oldu. Üst Bilgiler ETag: string
201 Created	SubscriptionContract	Kullanıcı ürüne başarıyla abone oldu. Üst Bilgiler ETag: string
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Name

Tür

Description

200 OK

SubscriptionContract

Kullanıcı ürüne zaten abone oldu.

Üst Bilgiler

ETag: string

201 Created

SubscriptionContract

Kullanıcı ürüne başarıyla abone oldu.

Üst Bilgiler

ETag: string

Other Status Codes

ErrorResponse

İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

ApiManagementCreateWorkspaceSubscription

Örnek isteği

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/testsub?api-version=2024-05-01

{
  "properties": {
    "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
    "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002",
    "displayName": "testsub"
  }
}

Örnek yanıt

Durum kodu:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/testsub",
  "type": "Microsoft.ApiManagement/service/workspaces.subscriptions",
  "name": "testsub",
  "properties": {
    "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
    "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002",
    "displayName": "testsub",
    "state": "submitted",
    "createdDate": "2017-06-02T23:34:03.1055076Z"
  }
}

Durum kodu:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/subscriptions/testsub",
  "type": "Microsoft.ApiManagement/service/workspaces.subscriptions",
  "name": "testsub",
  "properties": {
    "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
    "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/products/5600b59475ff190048060002",
    "displayName": "testsub",
    "state": "submitted",
    "createdDate": "2017-06-02T23:34:03.1055076Z"
  }
}

Tanımlar

Name	Description
AppType	Oluşturma kullanıcı isteğini gönderen uygulamanın türünü belirler. Varsayılan, eski portaldır.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
SubscriptionContract	Abonelik ayrıntıları.
SubscriptionCreateParameters	Abonelik oluşturma ayrıntıları.
SubscriptionState	Abonelik durumu. Olası durumlar * etkindir – abonelik etkin, * askıya alınmış – abonelik engellenir ve abone ürünün api'lerini çağıramaz, * gönderildi – abonelik isteği geliştirici tarafından yapılmış, ancak henüz onaylanmamış veya reddedilmemiş, * reddedildi – abonelik isteği bir yönetici tarafından reddedildi, * iptal edildi – abonelik geliştirici veya yönetici tarafından iptal edildi, * süresi doldu – abonelik son kullanma tarihine ulaştı ve devre dışı bırakıldı.

AppType

Listeleme

Oluşturma kullanıcı isteğini gönderen uygulamanın türünü belirler. Varsayılan, eski portaldır.

Değer	Description
portal	Kullanıcı oluşturma isteği eski geliştirici portalı tarafından gönderildi.
developerPortal	Kullanıcı oluşturma isteği yeni geliştirici portalı tarafından gönderildi.

ErrorAdditionalInfo

Object

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Object

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Object

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

SubscriptionContract

Object

Abonelik ayrıntıları.

Name	Tür	Description
id	string	Kaynağın tam kaynak kimliği. Örn - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Kaynağın adı
properties.allowTracing	boolean	İzlemenin etkinleştirilip etkinleştirilmediğini belirler
properties.createdDate	string (date-time)	Abonelik oluşturma tarihi. Tarih şu biçime uygundur: ISO 8601 standardı tarafından belirtilen `yyyy-MM-ddTHH:mm:ssZ`.
properties.displayName	string minLength: 0 maxLength: 100	Aboneliğin adı veya adı yoksa null.
properties.endDate	string (date-time)	Aboneliğin iptal edildiği veya süresinin dolduğu tarih. Bu ayar yalnızca denetim amaçlıdır ve abonelik otomatik olarak iptal edilmez. Abonelik yaşam döngüsü `state` özelliği kullanılarak yönetilebilir. Tarih şu biçime uygundur: ISO 8601 standardı tarafından belirtilen `yyyy-MM-ddTHH:mm:ssZ`.
properties.expirationDate	string (date-time)	Abonelik sona erme tarihi. Bu ayar yalnızca denetim amaçlıdır ve aboneliğin süresi otomatik olarak dolmaz. Abonelik yaşam döngüsü `state` özelliği kullanılarak yönetilebilir. Tarih şu biçime uygundur: ISO 8601 standardı tarafından belirtilen `yyyy-MM-ddTHH:mm:ssZ`.
properties.notificationDate	string (date-time)	Yaklaşan abonelik süre sonu bildirim tarihi. Tarih şu biçime uygundur: ISO 8601 standardı tarafından belirtilen `yyyy-MM-ddTHH:mm:ssZ`.
properties.ownerId	string	Abonelik sahibinin kullanıcı kaynak tanımlayıcısı. Değer, /users/{userId} biçiminde geçerli bir göreli URL'dir; burada {userId} bir kullanıcı tanımlayıcısıdır.
properties.primaryKey	string minLength: 1 maxLength: 256	Abonelik birincil anahtarı. Bu özellik 'GET' işlemlerinde doldurulmayacak! Değeri almak için '/listSecrets' POST isteğini kullanın.
properties.scope	string	/products/{productId} veya /apis veya /apis/{apiId} gibi kapsam.
properties.secondaryKey	string minLength: 1 maxLength: 256	Abonelik ikincil anahtarı. Bu özellik 'GET' işlemlerinde doldurulmayacak! Değeri almak için '/listSecrets' POST isteğini kullanın.
properties.startDate	string (date-time)	Abonelik etkinleştirme tarihi. Bu ayar yalnızca denetim amaçlıdır ve abonelik otomatik olarak etkinleştirilmez. Abonelik yaşam döngüsü `state` özelliği kullanılarak yönetilebilir. Tarih şu biçime uygundur: ISO 8601 standardı tarafından belirtilen `yyyy-MM-ddTHH:mm:ssZ`.
properties.state	SubscriptionState	Abonelik durumu. Olası durumlar * etkindir – abonelik etkin, * askıya alınmış – abonelik engellenir ve abone ürünün api'lerini çağıramaz, * gönderildi – abonelik isteği geliştirici tarafından yapılmış, ancak henüz onaylanmamış veya reddedilmemiş, * reddedildi – abonelik isteği bir yönetici tarafından reddedildi, * iptal edildi – abonelik geliştirici veya yönetici tarafından iptal edildi, * süresi doldu – abonelik son kullanma tarihine ulaştı ve devre dışı bırakıldı.
properties.stateComment	string	Durum 'reddedildi' olarak değiştirildiğinde yönetici tarafından eklenen isteğe bağlı abonelik açıklaması.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

SubscriptionCreateParameters

Object

Abonelik oluşturma ayrıntıları.

Name	Tür	Description
properties.allowTracing	boolean	İzlemenin etkinleştirilip etkinleştirilmeyeceğini belirler
properties.displayName	string minLength: 1 maxLength: 100	Abonelik adı.
properties.ownerId	string	Aboneliğin /users/{userId} biçiminde oluşturulduğu kullanıcı (kullanıcı kimliği yolu)
properties.primaryKey	string minLength: 1 maxLength: 256	Birincil abonelik anahtarı. İstek anahtarı sırasında belirtilmezse otomatik olarak oluşturulur.
properties.scope	string	/products/{productId} veya /apis veya /apis/{apiId} gibi kapsam.
properties.secondaryKey	string minLength: 1 maxLength: 256	İkincil abonelik anahtarı. İstek anahtarı sırasında belirtilmezse otomatik olarak oluşturulur.
properties.state	SubscriptionState	İlk abonelik durumu. Herhangi bir değer belirtilmezse, Abonelik Gönderildi durumuyla oluşturulur. Olası durumlar * etkindir – abonelik etkin, * askıya alınmış – abonelik engellenir ve abone ürünün api'lerini çağıramaz, * gönderildi – abonelik isteği geliştirici tarafından yapılmış, ancak henüz onaylanmamış veya reddedilmemiş, * reddedildi – abonelik isteği bir yönetici tarafından reddedildi, * iptal edildi – abonelik geliştirici veya yönetici tarafından iptal edildi, * süresi doldu – abonelik son kullanma tarihine ulaştı ve devre dışı bırakıldı.

SubscriptionState

Listeleme

Abonelik durumu. Olası durumlar * etkindir – abonelik etkin, * askıya alınmış – abonelik engellenir ve abone ürünün api'lerini çağıramaz, * gönderildi – abonelik isteği geliştirici tarafından yapılmış, ancak henüz onaylanmamış veya reddedilmemiş, * reddedildi – abonelik isteği bir yönetici tarafından reddedildi, * iptal edildi – abonelik geliştirici veya yönetici tarafından iptal edildi, * süresi doldu – abonelik son kullanma tarihine ulaştı ve devre dışı bırakıldı.

Değer	Description
suspended
active
expired
submitted
rejected
cancelled

Aracılığıyla paylaş

Workspace Subscription - Create Or Update

URI Parametreleri

İstek Başlığı

İstek Gövdesi

Yanıtlar

Güvenlik

azure_auth

Kapsamlar

Örnekler

ApiManagementCreateWorkspaceSubscription

Örnek isteği

Örnek yanıt

Tanımlar

AppType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SubscriptionContract

SubscriptionCreateParameters

SubscriptionState