Subscription - Create Or Update
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}/subscriptions/{sid}?api-version=2022-08-01
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 Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir. |
service
|
path | True |
string |
API Management hizmetinin adı. Normal ifade deseni: |
sid
|
path | True |
string |
Abonelik varlığı Tanımlayıcısı. Varlık, bir kullanıcı ile API Management'deki bir ürün arasındaki ilişkiyi temsil eder. Normal ifade deseni: |
subscription
|
path | True |
string |
Hedef aboneliğin kimliği. |
api-version
|
query | True |
string |
Bu işlem için kullanılacak API sürümü. |
app
|
query |
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 Durumu'ndaki değişikliği bildir.
|
İ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 |
Abonelik adı. |
properties.scope | True |
string |
/products/{productId} veya /apis veya /apis/{apiId} gibi kapsam. |
properties.allowTracing |
boolean |
İzlemenin etkinleştirilip etkinleştirilemeyeceğini belirler |
|
properties.ownerId |
string |
Aboneliğin /users/{userId} biçiminde oluşturulduğu kullanıcı (kullanıcı kimliği yolu) |
|
properties.primaryKey |
string |
Birincil abonelik anahtarı. İstek anahtarı sırasında belirtilmezse otomatik olarak oluşturulur. |
|
properties.secondaryKey |
string |
İkincil abonelik anahtarı. İstek anahtarı sırasında belirtilmezse otomatik olarak oluşturulur. |
|
properties.state |
İlk abonelik durumu. Herhangi bir değer belirtilmezse Abonelik Gönderildi durumuyla oluşturulur. Olası durumlar * etkindir – abonelik etkin, * askıya alındı – abonelik engellendi ve abone ürünün herhangi bir API'sini çağıramıyor, * 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 |
Kullanıcı ürüne zaten abone oldu. Üst Bilgiler ETag: string |
|
201 Created |
Kullanıcı ürüne başarıyla abone oldu. Üst Bilgiler ETag: string |
|
Other Status Codes |
İşlemin neden başarısız olduğunu açıklayan hata yanıtı. |
Güvenlik
azure_auth
Azure Active Directory OAuth2 Flow.
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
ApiManagementCreateSubscription
Örnek isteği
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"
}
}
Örnek yanıt
{
"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"
}
}
{
"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"
}
}
Tanımlar
Name | Description |
---|---|
App |
Oluşturma kullanıcı isteğini gönderen uygulamanın türünü belirler. Varsayılan, eski yayımcı portalıdır. |
Error |
Hata Alanı sözleşmesi. |
Error |
Hata Yanıtı. |
Subscription |
Abonelik ayrıntıları. |
Subscription |
Abonelik oluşturma ayrıntıları. |
Subscription |
Abonelik durumu. Olası durumlar * etkindir – abonelik etkin, * askıya alındı – abonelik engellendi ve abone ürünün herhangi bir API'sini çağıramıyor, * 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
Oluşturma kullanıcı isteğini gönderen uygulamanın türünü belirler. Varsayılan, eski yayımcı portalıdır.
Name | Tür | Description |
---|---|---|
developerPortal |
string |
Kullanıcı oluşturma isteği yeni geliştirici portalı tarafından gönderildi. |
portal |
string |
Kullanıcı oluşturma isteği eski geliştirici portalı tarafından gönderildi. |
ErrorFieldContract
Hata Alanı sözleşmesi.
Name | Tür | Description |
---|---|---|
code |
string |
Özellik düzeyi hata kodu. |
message |
string |
Özellik düzeyi hatanın insan tarafından okunabilir gösterimi. |
target |
string |
Özellik adı. |
ErrorResponse
Hata Yanıtı.
Name | Tür | Description |
---|---|---|
error.code |
string |
Hizmet tanımlı hata kodu. Bu kod, yanıtta belirtilen HTTP hata kodu için bir alt durum görevi görür. |
error.details |
Doğrulama hatası durumunda istekte gönderilen geçersiz alanların listesi. |
|
error.message |
string |
Hatanın insan tarafından okunabilen gösterimi. |
SubscriptionContract
Abonelik ayrıntıları.
Name | Tür | Description |
---|---|---|
id |
string |
Kaynağın tam kaynak kimliği. Ex - /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 |
Abonelik oluşturma tarihi. Tarih şu biçime uygundur: |
properties.displayName |
string |
Aboneliğin adı veya aboneliğin adı yoksa null. |
properties.endDate |
string |
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ü özelliği kullanılarak |
properties.expirationDate |
string |
Aboneliğin 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ü özelliği kullanılarak |
properties.notificationDate |
string |
Yaklaşan abonelik süre sonu bildirim tarihi. Tarih şu biçime uygundur: |
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 |
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 |
Abonelik ikincil anahtarı. Bu özellik 'GET' işlemlerinde doldurulmayacak! Değeri almak için '/listSecrets' POST isteğini kullanın. |
properties.startDate |
string |
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ü özelliği kullanılarak |
properties.state |
Abonelik durumu. Olası durumlar * etkindir – abonelik etkin, * askıya alındı – abonelik engellendi ve abone ürünün herhangi bir API'sini çağıramıyor, * 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
Abonelik oluşturma ayrıntıları.
Name | Tür | Description |
---|---|---|
properties.allowTracing |
boolean |
İzlemenin etkinleştirilip etkinleştirilemeyeceğini belirler |
properties.displayName |
string |
Abonelik adı. |
properties.ownerId |
string |
Aboneliğin /users/{userId} biçiminde oluşturulduğu kullanıcı (kullanıcı kimliği yolu) |
properties.primaryKey |
string |
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 |
İkincil abonelik anahtarı. İstek anahtarı sırasında belirtilmezse otomatik olarak oluşturulur. |
properties.state |
İlk abonelik durumu. Herhangi bir değer belirtilmezse Abonelik Gönderildi durumuyla oluşturulur. Olası durumlar * etkindir – abonelik etkin, * askıya alındı – abonelik engellendi ve abone ürünün herhangi bir API'sini çağıramıyor, * 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
Abonelik durumu. Olası durumlar * etkindir – abonelik etkin, * askıya alındı – abonelik engellendi ve abone ürünün herhangi bir API'sini çağıramıyor, * 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ı.
Name | Tür | Description |
---|---|---|
active |
string |
|
cancelled |
string |
|
expired |
string |
|
rejected |
string |
|
submitted |
string |
|
suspended |
string |