User - Create Or Update
Kullanıcı oluşturur veya Güncelleştirmeler.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}?api-version=2022-08-01
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}?notify={notify}&api-version=2022-08-01
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: |
subscription
|
path | True |
string |
Hedef aboneliğin kimliği. |
user
|
path | True |
string |
Kullanıcı tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. |
api-version
|
query | True |
string |
Bu işlem için kullanılacak API sürümü. |
notify
|
query |
boolean |
Kullanıcıya bir Email 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.email | True |
string |
E-posta adresi. Boş olmamalıdır ve hizmet örneği içinde benzersiz olmalıdır. |
properties.firstName | True |
string |
Adı. |
properties.lastName | True |
string |
Soyadı. |
properties.appType |
Oluşturma kullanıcı isteğini gönderen uygulamanın türünü belirler. Varsayılan, eski portaldır. |
||
properties.confirmation |
Yeni oluşturulan kullanıcıya gönderilecek onay e-postasının türünü belirler. |
||
properties.identities |
Kullanıcı kimlikleri koleksiyonu. |
||
properties.note |
string |
Yönetici tarafından ayarlanan kullanıcı hakkında isteğe bağlı not. |
|
properties.password |
string |
Kullanıcı Parolası. Değer sağlanmazsa, varsayılan bir parola oluşturulur. |
|
properties.state |
Hesap durumu. Kullanıcının etkin olup olmadığını belirtir. Engellenen kullanıcılar geliştirici portalında oturum açamaz veya abone olunan ürünlerin API'lerini çağıramaz. Varsayılan durum Etkin'dir. |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
Kullanıcı başarıyla güncelleştirildi. Üst Bilgiler ETag: string |
|
201 Created |
Kullanıcı başarıyla oluşturuldu. Ü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
ApiManagementCreateUser
Örnek isteği
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b?api-version=2022-08-01
{
"properties": {
"firstName": "foo",
"lastName": "bar",
"email": "foobar@outlook.com",
"confirmation": "signup"
}
}
Örnek yanıt
{
"id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b",
"type": "Microsoft.ApiManagement/service/users",
"name": "5931a75ae4bbd512288c680b",
"properties": {
"firstName": "foo",
"lastName": "bar",
"email": "foobar@outlook.com",
"state": "active",
"registrationDate": "2018-01-07T21:21:29.16Z",
"groups": [],
"identities": [
{
"provider": "Basic",
"id": "foobar@outlook.com"
}
]
}
}
{
"id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b",
"type": "Microsoft.ApiManagement/service/users",
"name": "5931a75ae4bbd512288c680b",
"properties": {
"firstName": "foo",
"lastName": "bar",
"email": "foobar@outlook.com",
"state": "active",
"registrationDate": "2018-01-07T21:21:29.16Z",
"groups": [],
"identities": [
{
"provider": "Basic",
"id": "foobar@outlook.com"
}
]
}
}
Tanımlar
Name | Description |
---|---|
App |
Oluşturma kullanıcı isteğini gönderen uygulamanın türünü belirler. Varsayılan, eski portaldır. |
Confirmation |
Yeni oluşturulan kullanıcıya gönderilecek onay e-postasının türünü belirler. |
Error |
Hata Alanı sözleşmesi. |
Error |
Hata Yanıtı. |
Group |
Grup sözleşmesi Özellikleri. |
Group |
Grup türü. |
User |
Kullanıcı ayrıntıları. |
User |
Kullanıcı oluşturma ayrıntıları. |
User |
Kullanıcı kimliği ayrıntıları. |
User |
Hesap durumu. Kullanıcının etkin olup olmadığını belirtir. Engellenen kullanıcılar geliştirici portalında oturum açamaz veya abone olunan ürünlerin API'lerini çağıramaz. Varsayılan durum Etkin'dir. |
AppType
Oluşturma kullanıcı isteğini gönderen uygulamanın türünü belirler. Varsayılan, eski portaldı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. |
Confirmation
Yeni oluşturulan kullanıcıya gönderilecek onay e-postasının türünü belirler.
Name | Tür | Description |
---|---|---|
invite |
string |
Kullanıcıyı kaydolmaya ve kaydı tamamlamaya davet eden bir e-posta gönderin. |
signup |
string |
Kullanıcıya başarıyla kaydoldıklarını onaylayan bir e-posta gönderin. |
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. |
GroupContractProperties
Grup sözleşmesi Özellikleri.
Name | Tür | Description |
---|---|---|
builtIn |
boolean |
Grup üç sistem grubundan biriyse (Yöneticiler, Geliştiriciler veya Konuklar); aksi takdirde false. |
description |
string |
Grup açıklaması. HTML biçimlendirme etiketleri içerebilir. |
displayName |
string |
Grup adı. |
externalId |
string |
Dış gruplar için, bu özellik dış kimlik sağlayıcısından gelen grubun kimliğini (örneğin Azure Active Directory |
type |
Grup türü. |
GroupType
Grup türü.
Name | Tür | Description |
---|---|---|
custom |
string |
|
external |
string |
|
system |
string |
UserContract
Kullanıcı ayrıntıları.
Name | Tür | Default value | Description |
---|---|---|---|
id |
string |
Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
|
name |
string |
Kaynağın adı |
|
properties.email |
string |
E-posta adresi. |
|
properties.firstName |
string |
Adı. |
|
properties.groups |
Kullanıcının parçası olduğu grup koleksiyonu. |
||
properties.identities |
Kullanıcı kimlikleri koleksiyonu. |
||
properties.lastName |
string |
Soyadı. |
|
properties.note |
string |
Yönetici tarafından ayarlanan kullanıcı hakkında isteğe bağlı not. |
|
properties.registrationDate |
string |
Kullanıcı kaydı tarihi. Tarih şu biçime uygundur: |
|
properties.state | active |
Hesap durumu. Kullanıcının etkin olup olmadığını belirtir. Engellenen kullanıcılar geliştirici portalında oturum açamaz veya abone olunan ürünlerin API'lerini çağıramaz. Varsayılan durum Etkin'dir. |
|
type |
string |
Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts" |
UserCreateParameters
Kullanıcı oluşturma ayrıntıları.
Name | Tür | Default value | Description |
---|---|---|---|
properties.appType |
Oluşturma kullanıcı isteğini gönderen uygulamanın türünü belirler. Varsayılan, eski portaldır. |
||
properties.confirmation |
Yeni oluşturulan kullanıcıya gönderilecek onay e-postasının türünü belirler. |
||
properties.email |
string |
E-posta adresi. Boş olmamalıdır ve hizmet örneği içinde benzersiz olmalıdır. |
|
properties.firstName |
string |
Adı. |
|
properties.identities |
Kullanıcı kimlikleri koleksiyonu. |
||
properties.lastName |
string |
Soyadı. |
|
properties.note |
string |
Yönetici tarafından ayarlanan kullanıcı hakkında isteğe bağlı not. |
|
properties.password |
string |
Kullanıcı Parolası. Değer sağlanmazsa, varsayılan bir parola oluşturulur. |
|
properties.state | active |
Hesap durumu. Kullanıcının etkin olup olmadığını belirtir. Engellenen kullanıcılar geliştirici portalında oturum açamaz veya abone olunan ürünlerin API'lerini çağıramaz. Varsayılan durum Etkin'dir. |
UserIdentityContract
Kullanıcı kimliği ayrıntıları.
Name | Tür | Description |
---|---|---|
id |
string |
Sağlayıcı içindeki tanımlayıcı değeri. |
provider |
string |
Kimlik sağlayıcısı adı. |
UserState
Hesap durumu. Kullanıcının etkin olup olmadığını belirtir. Engellenen kullanıcılar geliştirici portalında oturum açamaz veya abone olunan ürünlerin API'lerini çağıramaz. Varsayılan durum Etkin'dir.
Name | Tür | Description |
---|---|---|
active |
string |
Kullanıcı durumu etkin. |
blocked |
string |
Kullanıcı engellendi. Engellenen kullanıcılar geliştirici portalında veya çağrı API'sinde kimlik doğrulaması yapamaz. |
deleted |
string |
Kullanıcı hesabı kapatıldı. Tüm kimlikler ve ilgili varlıklar kaldırılır. |
pending |
string |
Kullanıcı hesabı beklemede. Etkin hale getirilmeden önce kimlik onayı gerektirir. |