forked from MicrosoftDocs/azure-docs-cli
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathnode.yml
More file actions
233 lines (233 loc) · 10.9 KB
/
node.yml
File metadata and controls
233 lines (233 loc) · 10.9 KB
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
### YamlMime:UniversalReference
items:
- uid: az_batch_node
name: az batch node
summary: Manage your Batch compute nodes.
langs:
- azurecli
children:
- az_batch_node_delete
- az_batch_node_list
- az_batch_node_reboot
- az_batch_node_reimage
- az_batch_node_show
- uid: az_batch_node_delete
name: az batch node delete
summary: Removes compute nodes from the specified pool.
langs:
- azurecli
parameters:
- isRequired: true
name: --pool-id
summary: The ID of the pool from which you want to remove nodes.
- name: --json-file
summary: A file containing the node remove parameter specification in JSON format. If this parameter is specified, all 'Node Remove Arguments' are ignored.
- name: --account-endpoint
summary: 'Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.'
- name: --account-key
summary: 'Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.'
- name: --account-name
summary: 'Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.'
- name: --node-deallocation-option
parameterValueGroup: requeue, retainedData, taskCompletion, terminate
summary: Determines what to do with a node and its running task(s) after it has been selected for deallocation. The default value is requeue.
- name: --node-list
summary: A list containing the ids of the compute nodes to be removed from the specified pool. Space separated values.
- name: --resize-timeout
summary: The timeout for removal of compute nodes to the pool. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). Expected format is an ISO-8601 duration.
- name: --if-match
summary: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.
- name: --if-modified-since
summary: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
- name: --if-none-match
summary: An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.
- name: --if-unmodified-since
summary: A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
source:
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
remote:
branch: chaochen
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
repo: https://github.com/azure/azure-cli/.git
- uid: az_batch_node_list
name: az batch node list
summary: Lists the compute nodes in the specified pool.
langs:
- azurecli
parameters:
- isRequired: true
name: --pool-id
summary: The ID of the pool from which you want to list nodes.
- name: --account-endpoint
summary: 'Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.'
- name: --account-key
summary: 'Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.'
- name: --account-name
summary: 'Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.'
- name: --filter
summary: An OData $filter clause..
- name: --select
summary: An OData $select clause.
source:
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
remote:
branch: chaochen
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
repo: https://github.com/azure/azure-cli/.git
- uid: az_batch_node_reboot
name: az batch node reboot
summary: Restarts the specified compute node.
langs:
- azurecli
parameters:
- isRequired: true
name: --node-id
summary: The ID of the compute node that you want to restart.
- isRequired: true
name: --pool-id
summary: The ID of the pool that contains the compute node.
- name: --node-reboot-option
parameterValueGroup: "'''requeue'', ''retainedData'', ''taskCompletion'', ''terminate'''"
summary: When to reboot the compute node and what to do with currently running tasks. The default value is requeue.
- name: --account-endpoint
summary: 'Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.'
- name: --account-key
summary: 'Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.'
- name: --account-name
summary: 'Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.'
source:
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
remote:
branch: chaochen
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
repo: https://github.com/azure/azure-cli/.git
- uid: az_batch_node_reimage
name: az batch node reimage
summary: Reinstalls the operating system on the specified compute node.
langs:
- azurecli
parameters:
- isRequired: true
name: --node-id
summary: The ID of the compute node that you want to restart.
- isRequired: true
name: --pool-id
summary: The ID of the pool that contains the compute node.
- name: --node-reimage-option
parameterValueGroup: "'''requeue'', ''retainedData'', ''taskCompletion'', ''terminate'''"
summary: When to reimage the compute node and what to do with currently running tasks. The default value is requeue.
- name: --account-endpoint
summary: 'Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.'
- name: --account-key
summary: 'Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.'
- name: --account-name
summary: 'Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.'
source:
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
remote:
branch: chaochen
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
repo: https://github.com/azure/azure-cli/.git
- uid: az_batch_node_show
name: az batch node show
summary: Gets information about the specified compute node.
langs:
- azurecli
parameters:
- isRequired: true
name: --node-id
summary: The ID of the compute node that you want to get information about.
- isRequired: true
name: --pool-id
summary: The ID of the pool that contains the compute node.
- name: --account-endpoint
summary: 'Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.'
- name: --account-key
summary: 'Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.'
- name: --account-name
summary: 'Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.'
- name: --select
summary: An OData $select clause.
source:
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
remote:
branch: chaochen
path: src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py
repo: https://github.com/azure/azure-cli/.git
commands:
- uid: az_batch_node_delete
name: az batch node delete
summary: Removes compute nodes from the specified pool.
- uid: az_batch_node_file
name: az batch node file
summary: Manage your Batch compute node files.
- uid: az_batch_node_file_delete
name: az batch node file delete
summary: Deletes the specified file from the compute node.
- uid: az_batch_node_file_download
name: az batch node file download
summary: Download the content of the specified node file.
- uid: az_batch_node_file_list
name: az batch node file list
summary: Lists all of the files in task directories on the specified compute node.
- uid: az_batch_node_file_show
name: az batch node file show
summary: Gets the properties of the specified compute node file.
- uid: az_batch_node_list
name: az batch node list
summary: Lists the compute nodes in the specified pool.
- uid: az_batch_node_reboot
name: az batch node reboot
summary: Restarts the specified compute node.
- uid: az_batch_node_reimage
name: az batch node reimage
summary: Reinstalls the operating system on the specified compute node.
- uid: az_batch_node_remote-desktop
name: az batch node remote-desktop
summary: Retrieve the remote desktop protocol for a Batch compute node.
- uid: az_batch_node_remote-desktop_download
name: az batch node remote-desktop download
summary: Gets the Remote Desktop Protocol file for the specified compute node.
- uid: az_batch_node_remote-login-settings
name: az batch node remote-login-settings
summary: Retrieve the remote login settings for a Batch compute node.
- uid: az_batch_node_remote-login-settings_show
name: az batch node remote-login-settings show
summary: Gets the settings required for remote login to a compute node.
- uid: az_batch_node_scheduling
name: az batch node scheduling
summary: Manage task scheduling for a Batch compute node.
- uid: az_batch_node_scheduling_disable
name: az batch node scheduling disable
summary: Disables task scheduling on the specified compute node.
- uid: az_batch_node_scheduling_enable
name: az batch node scheduling enable
summary: Enables task scheduling on the specified compute node.
- uid: az_batch_node_show
name: az batch node show
summary: Gets information about the specified compute node.
- uid: az_batch_node_user
name: az batch node user
summary: Manage the user accounts of your Batch compute node.
- uid: az_batch_node_user_create
name: az batch node user create
summary: Add a user account to the specified compute node.
- uid: az_batch_node_user_delete
name: az batch node user delete
summary: Deletes a user account from the specified compute node.
- uid: az_batch_node_user_reset
name: az batch node user reset
summary: Update the properties of a user account on the specified compute node. All updatable properties are replaced with the values specified or reset if unspecified.
globalParameters:
- name: --debug
summary: Increase logging verbosity to show all debug logs.
- name: --help -h
summary: Show this help message and exit.
- name: --output -o
defaultValue: json
parameterValueGroup: json, jsonc, table, tsv
summary: Output format.
- name: --query
summary: JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
- name: --verbose
summary: Increase logging verbosity. Use --debug for full debug logs.