forked from MicrosoftDocs/azure-docs-cli
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathqueue.yml
More file actions
241 lines (241 loc) · 11.9 KB
/
queue.yml
File metadata and controls
241 lines (241 loc) · 11.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
234
235
236
237
238
239
240
241
### YamlMime:UniversalReference
items:
- uid: az_storage_queue
name: az storage queue
summary: Use queues to effectively scale applications according to traffic.
langs:
- azurecli
children:
- az_storage_queue_create
- az_storage_queue_delete
- az_storage_queue_exists
- az_storage_queue_generate-sas
- az_storage_queue_list
- az_storage_queue_stats
- uid: az_storage_queue_create
name: az storage queue create
summary: Creates a queue under the given account.
langs:
- azurecli
parameters:
- isRequired: true
name: --name -n
summary: The queue name.
- name: --fail-on-exist
summary: Specifies whether to throw an exception if the queue already exists.
- name: --metadata
summary: Metadata in space-separated key=value pairs. This overwrites any existing metadata.
- name: --timeout
summary: Request timeout in seconds. Applies to each call to the service.
- name: --account-key
summary: 'Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.'
- name: --account-name
summary: 'Storage account name. Must be used in conjunction with either storage account key or a SAS token. Environment variable: AZURE_STORAGE_ACCOUNT.'
- name: --connection-string
summary: 'Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.'
- name: --sas-token
summary: 'A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.'
source:
path: src/command_modules/azure-cli-storage/azure/cli/command_modules/storage/_help.py
remote:
branch: chaochen
path: src/command_modules/azure-cli-storage/azure/cli/command_modules/storage/_help.py
repo: https://github.com/azure/azure-cli/.git
- uid: az_storage_queue_delete
name: az storage queue delete
summary: Deletes the specified queue and any messages it contains.
langs:
- azurecli
parameters:
- isRequired: true
name: --name -n
summary: The queue name.
- name: --fail-not-exist
summary: Specifies whether to throw an exception if the queue doesn't exist.
- name: --timeout
summary: Request timeout in seconds. Applies to each call to the service.
- name: --account-key
summary: 'Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.'
- name: --account-name
summary: 'Storage account name. Must be used in conjunction with either storage account key or a SAS token. Environment variable: AZURE_STORAGE_ACCOUNT.'
- name: --connection-string
summary: 'Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.'
- name: --sas-token
summary: 'A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.'
source:
path: src/command_modules/azure-cli-storage/azure/cli/command_modules/storage/_help.py
remote:
branch: chaochen
path: src/command_modules/azure-cli-storage/azure/cli/command_modules/storage/_help.py
repo: https://github.com/azure/azure-cli/.git
- uid: az_storage_queue_exists
name: az storage queue exists
summary: Returns a boolean indicating whether the queue exists.
langs:
- azurecli
parameters:
- isRequired: true
name: --name -n
summary: The queue name.
- name: --timeout
summary: Request timeout in seconds. Applies to each call to the service.
- name: --account-key
summary: 'Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.'
- name: --account-name
summary: 'Storage account name. Must be used in conjunction with either storage account key or a SAS token. Environment variable: AZURE_STORAGE_ACCOUNT.'
- name: --connection-string
summary: 'Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.'
- name: --sas-token
summary: 'A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.'
source:
path: src/command_modules/azure-cli-storage/azure/cli/command_modules/storage/_help.py
remote:
branch: chaochen
path: src/command_modules/azure-cli-storage/azure/cli/command_modules/storage/_help.py
repo: https://github.com/azure/azure-cli/.git
- uid: az_storage_queue_generate-sas
name: az storage queue generate-sas
summary: Generates a shared access signature for the queue.
langs:
- azurecli
parameters:
- isRequired: true
name: --name -n
summary: The queue name.
- name: --expiry
summary: Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes invalid. Do not use if a stored access policy is referenced with --id that specifies this value.
- name: --https-only
summary: Only permit requests made with the HTTPS protocol. If omitted, requests from both the HTTP and HTTPS protocol are permitted.
- name: --ip
summary: Specifies the IP address or range of IP addresses from which to accept requests. Supports only IPv4 style addresses.
- name: --permissions
summary: 'The permissions the SAS grants. Allowed values: (a)dd (p)rocess (r)ead (u)pdate. Do not use if a stored access policy is referenced with --id that specifies this value. Can be combined.'
- name: --policy-name
summary: The name of a stored access policy within the queue's ACL.
- name: --start
summary: Specifies the UTC datetime (Y-m-d'T'H:M'Z') at which the SAS becomes valid. Do not use if a stored access policy is referenced with --id that specifies this value. Defaults to the time of the request.
- name: --account-key
summary: 'Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.'
- name: --account-name
summary: 'Storage account name. Must be used in conjunction with either storage account key or a SAS token. Environment variable: AZURE_STORAGE_ACCOUNT.'
- name: --connection-string
summary: 'Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.'
- name: --sas-token
summary: 'A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.'
source:
path: src/command_modules/azure-cli-storage/azure/cli/command_modules/storage/_help.py
remote:
branch: chaochen
path: src/command_modules/azure-cli-storage/azure/cli/command_modules/storage/_help.py
repo: https://github.com/azure/azure-cli/.git
- uid: az_storage_queue_list
name: az storage queue list
summary: List queues in a storage account.
langs:
- azurecli
parameters:
- name: --include-metadata
summary: Specifies that container metadata be returned in the response.
- name: --marker
summary: An opaque continuation token. This value can be retrieved from the next_marker field of a previous generator object if num_results was specified and that generator has finished enumerating results. If specified, this generator will begin returning results from the point where the previous generator stopped.
- name: --num-results
summary: The maximum number of queues to return.
- name: --prefix
summary: Filters the results to return only queues with names that begin with the specified prefix.
- name: --timeout
summary: Request timeout in seconds. Applies to each call to the service.
- name: --account-key
summary: 'Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.'
- name: --account-name
summary: 'Storage account name. Must be used in conjunction with either storage account key or a SAS token. Environment variable: AZURE_STORAGE_ACCOUNT.'
- name: --connection-string
summary: 'Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.'
- name: --sas-token
summary: 'A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.'
source:
path: src/command_modules/azure-cli-storage/azure/cli/command_modules/storage/_help.py
remote:
branch: chaochen
path: src/command_modules/azure-cli-storage/azure/cli/command_modules/storage/_help.py
repo: https://github.com/azure/azure-cli/.git
- uid: az_storage_queue_stats
name: az storage queue stats
summary: Retrieves statistics related to replication for the Queue service.
langs:
- azurecli
parameters:
- name: --timeout
summary: Request timeout in seconds. Applies to each call to the service.
- name: --account-key
summary: 'Storage account key. Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_KEY.'
- name: --account-name
summary: 'Storage account name. Must be used in conjunction with either storage account key or a SAS token. Environment variable: AZURE_STORAGE_ACCOUNT.'
- name: --connection-string
summary: 'Storage account connection string. Environment variable: AZURE_STORAGE_CONNECTION_STRING.'
- name: --sas-token
summary: 'A Shared Access Signature (SAS). Must be used in conjunction with storage account name. Environment variable: AZURE_STORAGE_SAS_TOKEN.'
source:
path: src/command_modules/azure-cli-storage/azure/cli/command_modules/storage/_help.py
remote:
branch: chaochen
path: src/command_modules/azure-cli-storage/azure/cli/command_modules/storage/_help.py
repo: https://github.com/azure/azure-cli/.git
commands:
- uid: az_storage_queue_create
name: az storage queue create
summary: Creates a queue under the given account.
- uid: az_storage_queue_delete
name: az storage queue delete
summary: Deletes the specified queue and any messages it contains.
- uid: az_storage_queue_exists
name: az storage queue exists
summary: Returns a boolean indicating whether the queue exists.
- uid: az_storage_queue_generate-sas
name: az storage queue generate-sas
summary: Generates a shared access signature for the queue.
- uid: az_storage_queue_list
name: az storage queue list
summary: List queues in a storage account.
- uid: az_storage_queue_metadata
name: az storage queue metadata
summary: Manage the metadata for a storage queue.
- uid: az_storage_queue_metadata_show
name: az storage queue metadata show
summary: Retrieves user-defined metadata and queue properties on the specified queue.
- uid: az_storage_queue_metadata_update
name: az storage queue metadata update
summary: Sets user-defined metadata on the specified queue.
- uid: az_storage_queue_policy
name: az storage queue policy
summary: Manage shared access policies for a storage queue.
- uid: az_storage_queue_policy_create
name: az storage queue policy create
summary: Create a stored access policy on the containing object.
- uid: az_storage_queue_policy_delete
name: az storage queue policy delete
summary: Delete a stored access policy on a containing object.
- uid: az_storage_queue_policy_list
name: az storage queue policy list
summary: List stored access policies on a containing object.
- uid: az_storage_queue_policy_show
name: az storage queue policy show
summary: Show a stored access policy on a containing object.
- uid: az_storage_queue_policy_update
name: az storage queue policy update
summary: Set a stored access policy on a containing object.
- uid: az_storage_queue_stats
name: az storage queue stats
summary: Retrieves statistics related to replication for the Queue service.
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.