-
Notifications
You must be signed in to change notification settings - Fork 239
/
azure.ai.ml.entities.AmlComputeSshSettings.yml
47 lines (46 loc) · 1.9 KB
/
azure.ai.ml.entities.AmlComputeSshSettings.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
### YamlMime:PythonClass
uid: azure.ai.ml.entities.AmlComputeSshSettings
name: AmlComputeSshSettings
fullName: azure.ai.ml.entities.AmlComputeSshSettings
module: azure.ai.ml.entities
inheritances:
- builtins.object
summary: SSH settings to access a AML compute target.
constructor:
syntax: 'AmlComputeSshSettings(*, admin_username: str, admin_password: str | None
= None, ssh_key_value: str | None = None)'
parameters:
- name: admin_username
description: SSH user name.
isRequired: true
types:
- <xref:str>
- name: admin_password
description: SSH user password. Defaults to None.
isRequired: true
types:
- <xref:str>
- name: ssh_key_value
description: 'The SSH RSA private key. Use "ssh-keygen -t
rsa -b 2048" to generate your SSH key pairs. Defaults to None.'
isRequired: true
types:
- <xref:typing.Optional>[<xref:str>]
keywordOnlyParameters:
- name: admin_username
isRequired: true
- name: admin_password
isRequired: true
- name: ssh_key_value
isRequired: true
examples:
- "Configuring an AmlComputeSshSettings object.<!--[!code-python[Main](les\\ml_samples_compute.py\
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
: [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\7\\\\azure-ai-ml-1.19.0\\\
\\samples\\\\ml_samples_compute.py\", \"xml:space\": \"preserve\", \"force\": false,\
\ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
: false} -->\n\n````python\n\n from azure.ai.ml.entities import AmlComputeSshSettings\n\
\n ssh_settings = AmlComputeSshSettings(\n admin_username=\"azureuser\"\
,\n ssh_key_value=\"ssh-rsa ABCDEFGHIJKLMNOPQRSTUVWXYZ administrator@MININT-2023\"\
,\n admin_password=\"password123\",\n )\n\n ````\n"