-
Notifications
You must be signed in to change notification settings - Fork 250
/
Copy pathazure.batch.models.BatchNodeUserUpdateContent.yml
144 lines (127 loc) · 4.84 KB
/
azure.batch.models.BatchNodeUserUpdateContent.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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
### YamlMime:PythonClass
uid: azure.batch.models.BatchNodeUserUpdateContent
name: BatchNodeUserUpdateContent
fullName: azure.batch.models.BatchNodeUserUpdateContent
module: azure.batch.models
summary: Parameters for updating a user account for RDP or SSH access on an Azure
Batch Compute Node.
constructor:
syntax: 'BatchNodeUserUpdateContent(*args: Any, **kwargs: Any)'
variables:
- description: 'The password of the Account. The password is required for Windows
Compute Nodes
(those created with ''virtualMachineConfiguration'' using a Windows Image reference).
For Linux
Compute Nodes, the password can optionally be specified along with the sshPublicKey
property.
If omitted, any existing password is removed.'
name: password
types:
- <xref:str>
- description: 'The time at which the Account should expire. If omitted, the default
is 1
day from the current time. For Linux Compute Nodes, the expiryTime has a precision
up to a day.'
name: expiry_time
types:
- <xref:datetime.datetime>
- description: 'The SSH public key that can be used for remote login to the Compute
Node.
The public key should be compatible with OpenSSH encoding and should be base 64
encoded. This
property can be specified only for Linux Compute Nodes. If this is specified for
a Windows
Compute Node, then the Batch service rejects the request; if you are calling the
REST API
directly, the HTTP status code is 400 (Bad Request). If omitted, any existing
SSH public key is
removed.'
name: ssh_public_key
types:
- <xref:str>
methods:
- uid: azure.batch.models.BatchNodeUserUpdateContent.as_dict
name: as_dict
summary: Return a dict that can be JSONify using json.dump.
signature: 'as_dict(*, exclude_readonly: bool = False) -> Dict[str, Any]'
keywordOnlyParameters:
- name: exclude_readonly
description: Whether to remove the readonly properties.
types:
- <xref:bool>
return:
description: A dict JSON compatible object
types:
- <xref:dict>
- uid: azure.batch.models.BatchNodeUserUpdateContent.clear
name: clear
signature: clear() -> None
- uid: azure.batch.models.BatchNodeUserUpdateContent.copy
name: copy
signature: copy() -> Model
- uid: azure.batch.models.BatchNodeUserUpdateContent.get
name: get
signature: 'get(key: str, default: Any = None) -> Any'
parameters:
- name: key
isRequired: true
- name: default
defaultValue: None
- uid: azure.batch.models.BatchNodeUserUpdateContent.items
name: items
signature: items() -> ItemsView[str, Any]
- uid: azure.batch.models.BatchNodeUserUpdateContent.keys
name: keys
signature: keys() -> KeysView[str]
- uid: azure.batch.models.BatchNodeUserUpdateContent.pop
name: pop
signature: 'pop(key: str, default: ~typing.Any = <object object>) -> Any'
parameters:
- name: key
isRequired: true
- name: default
- uid: azure.batch.models.BatchNodeUserUpdateContent.popitem
name: popitem
signature: popitem() -> Tuple[str, Any]
- uid: azure.batch.models.BatchNodeUserUpdateContent.setdefault
name: setdefault
signature: 'setdefault(key: str, default: ~typing.Any = <object object>) -> Any'
parameters:
- name: key
isRequired: true
- name: default
- uid: azure.batch.models.BatchNodeUserUpdateContent.update
name: update
signature: 'update(*args: Any, **kwargs: Any) -> None'
- uid: azure.batch.models.BatchNodeUserUpdateContent.values
name: values
signature: values() -> ValuesView[Any]
attributes:
- uid: azure.batch.models.BatchNodeUserUpdateContent.expiry_time
name: expiry_time
summary: 'The time at which the Account should expire. If omitted, the default is
1 day from the current
time. For Linux Compute Nodes, the expiryTime has a precision up to a day.'
signature: 'expiry_time: datetime | None'
- uid: azure.batch.models.BatchNodeUserUpdateContent.password
name: password
summary: 'The password of the Account. The password is required for Windows Compute
Nodes (those created
with ''virtualMachineConfiguration'' using a Windows Image reference). For Linux
Compute Nodes,
the password can optionally be specified along with the sshPublicKey property.
If omitted, any
existing password is removed.'
signature: 'password: str | None'
- uid: azure.batch.models.BatchNodeUserUpdateContent.ssh_public_key
name: ssh_public_key
summary: 'The SSH public key that can be used for remote login to the Compute Node.
The public key should
be compatible with OpenSSH encoding and should be base 64 encoded. This property
can be
specified only for Linux Compute Nodes. If this is specified for a Windows Compute
Node, then
the Batch service rejects the request; if you are calling the REST API directly,
the HTTP
status code is 400 (Bad Request). If omitted, any existing SSH public key is removed.'
signature: 'ssh_public_key: str | None'