Compute Node - Add User

Service:

Batch Service

API Version:

2023-11-01.18.0

Belirtilen İşlem Düğümüne bir kullanıcı Hesabı ekler.
İşlem Düğümü'ne kullanıcı hesabı eklemek için boşta veya çalışır durumda olması gerekir.

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/users?api-version=2023-11-01.18.0

With optional parameters:

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/users?timeout={timeout}&api-version=2023-11-01.18.0

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
batchUrl	path	True	string	Tüm Azure Batch hizmet isteklerinin temel URL'si.
nodeId	path	True	string	Kullanıcı Hesabı oluşturmak istediğiniz makinenin kimliği.
poolId	path	True	string	İşlem Düğümünü içeren Havuzun Kimliği.
api-version	query	True	string	İstemci API Sürümü.
timeout	query		integer int32	Sunucunun isteği işlemek için harcayabileceği en uzun süre (saniye olarak). Varsayılan değer 30 saniyedir.

İstek Başlığı

Media Types: "application/json; odata=minimalmetadata"

Name	Gerekli	Tür	Description
client-request-id		string uuid	Çağıranın oluşturduğu istek kimliği, küme ayraçları gibi süsleme içermeyen bir GUID biçimindedir; örneğin 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Sunucunun yanıtta client-request-id döndürip döndürmeyeceği.
ocp-date		string date-time-rfc1123	İsteğin verildiği saat. İstemci kitaplıkları bunu genellikle geçerli sistem saat saati olarak ayarlar; REST API'yi doğrudan çağırıyorsanız açıkça ayarlayın.

İstek Gövdesi

Media Types: "application/json; odata=minimalmetadata"

Name	Gerekli	Tür	Description
name	True	string	Hesabın kullanıcı adı.
expiryTime		string	Hesabın süresinin dolması gereken saat. Atlanırsa, varsayılan değer geçerli saatten itibaren 1 gündür. Linux İşlem Düğümleri için expiryTime değerinin bir güne kadar duyarlığı vardır.
isAdmin		boolean	Hesabın İşlem Düğümünde yönetici olup olmaması. Varsayılan değer false'tur.
password		string	Hesabın parolası. Parola, Windows İşlem Düğümleri için gereklidir ('cloudServiceConfiguration' ile oluşturulanlar veya bir Windows Görüntüsü başvurusu kullanılarak 'virtualMachineConfiguration' ile oluşturulanlar). Linux İşlem Düğümleri için parola isteğe bağlı olarak sshPublicKey özelliğiyle birlikte belirtilebilir.
sshPublicKey		string	İşlem Düğümünde uzaktan oturum açmak için kullanılabilecek SSH ortak anahtarı. Ortak anahtar OpenSSH kodlamasıyla uyumlu olmalı ve 64 tabanı kodlanmış olmalıdır. Bu özellik yalnızca Linux İşlem Düğümleri için belirtilebilir. Bu bir Windows İşlem Düğümü için belirtilirse Batch hizmeti isteği reddeder; REST API'yi doğrudan çağırıyorsanız HTTP durum kodu 400 (Hatalı İstek) olur.

Yanıtlar

Name	Tür	Description
201 Created		Batch hizmetine yapılan istek başarılı oldu. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Batch hizmetinden gelen hata.

Güvenlik

azure_auth

OAuth 2.0 kimlik doğrulama kodu akışını Microsoft Entra

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

Scopes

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

Authorization

Type: apiKey
In: header

Örnekler

Node add user

Sample Request

HTTP

POST account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/users?api-version=2023-11-01.18.0



{
  "name": "userName",
  "isAdmin": false,
  "expiryTime": "2017-08-01T00:00:00Z",
  "password": "Password"
}

Sample Response

Status code:

201

Tanımlar

Name	Description
BatchError	Azure Batch hizmetinden alınan bir hata yanıtı.
BatchErrorDetail	Azure Batch hata yanıtına eklenen ek bilgilerden oluşan bir öğe.
ComputeNodeUser	İşlem Düğümünde RDP veya SSH erişimi için kullanıcı Hesabı.
ErrorMessage	Azure Batch hata yanıtında alınan bir hata iletisi.

BatchError

Azure Batch hizmetinden alınan bir hata yanıtı.

Name	Tür	Description
code	string	Hatanın tanımlayıcısı. Kodlar sabittir ve program aracılığıyla kullanılması amaçlanmıştır.
message	ErrorMessage	Hatayı açıklayan ve kullanıcı arabiriminde görüntülenmeye uygun olması amaçlanan bir ileti.
values	BatchErrorDetail[]	Hatayla ilgili ek ayrıntıları içeren anahtar-değer çiftleri koleksiyonu.

BatchErrorDetail

Azure Batch hata yanıtına eklenen ek bilgilerden oluşan bir öğe.

Name	Tür	Description
key	string	Value özelliğinin anlamını belirten tanımlayıcı.
value	string	Hata yanıtına eklenen ek bilgiler.

ComputeNodeUser

İşlem Düğümünde RDP veya SSH erişimi için kullanıcı Hesabı.

Name	Tür	Description
expiryTime	string	Hesabın süresinin dolması gereken saat. Atlanırsa, varsayılan değer geçerli saatten itibaren 1 gündür. Linux İşlem Düğümleri için expiryTime değerinin bir güne kadar duyarlığı vardır.
isAdmin	boolean	Hesabın İşlem Düğümünde yönetici olup olmaması. Varsayılan değer false'tur.
name	string	Hesabın kullanıcı adı.
password	string	Hesabın parolası. Parola, Windows İşlem Düğümleri için gereklidir ('cloudServiceConfiguration' ile oluşturulanlar veya bir Windows Görüntüsü başvurusu kullanılarak 'virtualMachineConfiguration' ile oluşturulanlar). Linux İşlem Düğümleri için parola isteğe bağlı olarak sshPublicKey özelliğiyle birlikte belirtilebilir.
sshPublicKey	string	İşlem Düğümünde uzaktan oturum açmak için kullanılabilecek SSH ortak anahtarı. Ortak anahtar OpenSSH kodlamasıyla uyumlu olmalı ve 64 tabanı kodlanmış olmalıdır. Bu özellik yalnızca Linux İşlem Düğümleri için belirtilebilir. Bu bir Windows İşlem Düğümü için belirtilirse Batch hizmeti isteği reddeder; REST API'yi doğrudan çağırıyorsanız HTTP durum kodu 400 (Hatalı İstek) olur.

ErrorMessage

Azure Batch hata yanıtında alınan bir hata iletisi.

Name	Tür	Description
lang	string	Hata iletisinin dil kodu
value	string	İletinin metni.