-
Notifications
You must be signed in to change notification settings - Fork 245
/
azure.mgmt.storage.v2023_01_01.operations.QueueOperations.yml
263 lines (232 loc) · 8.79 KB
/
azure.mgmt.storage.v2023_01_01.operations.QueueOperations.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
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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
### YamlMime:PythonClass
uid: azure.mgmt.storage.v2023_01_01.operations.QueueOperations
name: QueueOperations
fullName: azure.mgmt.storage.v2023_01_01.operations.QueueOperations
module: azure.mgmt.storage.v2023_01_01.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
\ you should access the following operations through\n>\n> <xref:azure.mgmt.storage.v2023_01_01.StorageManagementClient>'s\n\
>\n> <xref:queue> attribute.\n>"
constructor:
syntax: QueueOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.storage.v2023_01_01.operations.QueueOperations.create
name: create
summary: Creates a new queue with the specified queue name, under the specified
account.
signature: 'create(resource_group_name: str, account_name: str, queue_name: str,
queue: _models.StorageQueue, *, content_type: str = ''application/json'', **kwargs:
Any) -> _models.StorageQueue'
parameters:
- name: resource_group_name
description: 'The name of the resource group within the user''s subscription.
The
name is case insensitive. Required.'
isRequired: true
types:
- <xref:str>
- name: account_name
description: 'The name of the storage account within the specified resource group.
Storage account names must be between 3 and 24 characters in length and use
numbers and
lower-case letters only. Required.'
isRequired: true
types:
- <xref:str>
- name: queue_name
description: 'A queue name must be unique within a storage account and must be
between 3
and 63 characters.The name must comprise of lowercase alphanumeric and dash(-)
characters only,
it should begin and end with an alphanumeric character and it cannot have two
consecutive
dash(-) characters. Required.'
isRequired: true
types:
- <xref:str>
- name: queue
description: 'Queue properties and metadata to be created with. Is either a StorageQueue
type
or a IO[bytes] type. Required.'
isRequired: true
types:
- <xref:azure.mgmt.storage.v2023_01_01.models.StorageQueue>
- <xref:typing.IO>[<xref:bytes>]
return:
description: StorageQueue or the result of cls(response)
types:
- <xref:azure.mgmt.storage.v2023_01_01.models.StorageQueue>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2023_01_01.operations.QueueOperations.delete
name: delete
summary: Deletes the queue with the specified queue name, under the specified account
if it exists.
signature: 'delete(resource_group_name: str, account_name: str, queue_name: str,
**kwargs: Any) -> None'
parameters:
- name: resource_group_name
description: 'The name of the resource group within the user''s subscription.
The
name is case insensitive. Required.'
isRequired: true
types:
- <xref:str>
- name: account_name
description: 'The name of the storage account within the specified resource group.
Storage account names must be between 3 and 24 characters in length and use
numbers and
lower-case letters only. Required.'
isRequired: true
types:
- <xref:str>
- name: queue_name
description: 'A queue name must be unique within a storage account and must be
between 3
and 63 characters.The name must comprise of lowercase alphanumeric and dash(-)
characters only,
it should begin and end with an alphanumeric character and it cannot have two
consecutive
dash(-) characters. Required.'
isRequired: true
types:
- <xref:str>
return:
description: None or the result of cls(response)
types:
- <xref:None>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2023_01_01.operations.QueueOperations.get
name: get
summary: Gets the queue with the specified queue name, under the specified account
if it exists.
signature: 'get(resource_group_name: str, account_name: str, queue_name: str, **kwargs:
Any) -> StorageQueue'
parameters:
- name: resource_group_name
description: 'The name of the resource group within the user''s subscription.
The
name is case insensitive. Required.'
isRequired: true
types:
- <xref:str>
- name: account_name
description: 'The name of the storage account within the specified resource group.
Storage account names must be between 3 and 24 characters in length and use
numbers and
lower-case letters only. Required.'
isRequired: true
types:
- <xref:str>
- name: queue_name
description: 'A queue name must be unique within a storage account and must be
between 3
and 63 characters.The name must comprise of lowercase alphanumeric and dash(-)
characters only,
it should begin and end with an alphanumeric character and it cannot have two
consecutive
dash(-) characters. Required.'
isRequired: true
types:
- <xref:str>
return:
description: StorageQueue or the result of cls(response)
types:
- <xref:azure.mgmt.storage.v2023_01_01.models.StorageQueue>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2023_01_01.operations.QueueOperations.list
name: list
summary: Gets a list of all the queues under the specified storage account.
signature: 'list(resource_group_name: str, account_name: str, maxpagesize: str |
None = None, filter: str | None = None, **kwargs: Any) -> Iterable[ListQueue]'
parameters:
- name: resource_group_name
description: 'The name of the resource group within the user''s subscription.
The
name is case insensitive. Required.'
isRequired: true
types:
- <xref:str>
- name: account_name
description: 'The name of the storage account within the specified resource group.
Storage account names must be between 3 and 24 characters in length and use
numbers and
lower-case letters only. Required.'
isRequired: true
types:
- <xref:str>
- name: maxpagesize
description: 'Optional, a maximum number of queues that should be included in
a list
queue response. Default value is None.'
isRequired: true
types:
- <xref:str>
- name: filter
description: 'Optional, When specified, only the queues with a name starting with
the given
filter will be listed. Default value is None.'
isRequired: true
types:
- <xref:str>
return:
description: An iterator like instance of either ListQueue or the result of cls(response)
types:
- <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.storage.v2023_01_01.models.ListQueue>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.storage.v2023_01_01.operations.QueueOperations.update
name: update
summary: Creates a new queue with the specified queue name, under the specified
account.
signature: 'update(resource_group_name: str, account_name: str, queue_name: str,
queue: _models.StorageQueue, *, content_type: str = ''application/json'', **kwargs:
Any) -> _models.StorageQueue'
parameters:
- name: resource_group_name
description: 'The name of the resource group within the user''s subscription.
The
name is case insensitive. Required.'
isRequired: true
types:
- <xref:str>
- name: account_name
description: 'The name of the storage account within the specified resource group.
Storage account names must be between 3 and 24 characters in length and use
numbers and
lower-case letters only. Required.'
isRequired: true
types:
- <xref:str>
- name: queue_name
description: 'A queue name must be unique within a storage account and must be
between 3
and 63 characters.The name must comprise of lowercase alphanumeric and dash(-)
characters only,
it should begin and end with an alphanumeric character and it cannot have two
consecutive
dash(-) characters. Required.'
isRequired: true
types:
- <xref:str>
- name: queue
description: 'Queue properties and metadata to be created with. Is either a StorageQueue
type
or a IO[bytes] type. Required.'
isRequired: true
types:
- <xref:azure.mgmt.storage.v2023_01_01.models.StorageQueue>
- <xref:typing.IO>[<xref:bytes>]
return:
description: StorageQueue or the result of cls(response)
types:
- <xref:azure.mgmt.storage.v2023_01_01.models.StorageQueue>
exceptions:
- type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.storage.v2023_01_01.operations.QueueOperations.models
name: models
signature: models = <module 'azure.mgmt.storage.v2023_01_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\storage\\v2023_01_01\\models\\__init__.py'>