QueueOperations Класс
Предупреждение
НЕ следует создавать экземпляр этого класса напрямую.
Вместо этого вы должны получить доступ к следующим операциям с помощью
атрибутqueue .
- Наследование
-
builtins.objectQueueOperations
Конструктор
QueueOperations(*args, **kwargs)
Методы
create |
Создает новую очередь с указанным именем очереди в указанной учетной записи. |
delete |
Удаляет очередь с указанным именем в указанной учетной записи, если она существует. |
get |
Возвращает очередь с указанным именем очереди в указанной учетной записи, если она существует. |
list |
Возвращает список всех очередей в указанной учетной записи хранения. |
update |
Создает новую очередь с указанным именем очереди в указанной учетной записи. |
create
Создает новую очередь с указанным именем очереди в указанной учетной записи.
create(resource_group_name: str, account_name: str, queue_name: str, queue: _models.StorageQueue, *, content_type: str = 'application/json', **kwargs: Any) -> _models.StorageQueue
Параметры
- resource_group_name
- str
Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается. Обязательный.
- account_name
- str
Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра. Обязательный.
- queue_name
- str
Имя очереди должно быть уникальным в пределах учетной записи хранения и содержать от 3 до 63 символов. Имя должно состоять только из буквенно-цифровых символов в нижнем регистре и символов dash(-), оно должно начинаться и заканчиваться буквенно-цифровым символом и не может содержать два последовательных символа dash(-). Обязательный.
- queue
- StorageQueue или IO
Свойства и метаданные очереди для создания. Тип StorageQueue или тип ввода-вывода. Обязательный.
- content_type
- str
Тип содержимого параметра тела. Известные значения: "application/json". Значение по умолчанию —Нет.
- cls
- callable
Пользовательский тип или функция, которые будут переданы в прямой ответ.
Возвращаемое значение
StorageQueue или результат cls(response)
Возвращаемый тип
Исключения
delete
Удаляет очередь с указанным именем в указанной учетной записи, если она существует.
delete(resource_group_name: str, account_name: str, queue_name: str, **kwargs: Any) -> None
Параметры
- resource_group_name
- str
Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается. Обязательный.
- account_name
- str
Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра. Обязательный.
- queue_name
- str
Имя очереди должно быть уникальным в пределах учетной записи хранения и содержать от 3 до 63 символов. Имя должно состоять только из буквенно-цифровых символов в нижнем регистре и символов dash(-), оно должно начинаться и заканчиваться буквенно-цифровым символом и не может содержать два последовательных символа dash(-). Обязательный.
- cls
- callable
Пользовательский тип или функция, которые будут переданы в прямой ответ.
Возвращаемое значение
None или результат cls(response)
Возвращаемый тип
Исключения
get
Возвращает очередь с указанным именем очереди в указанной учетной записи, если она существует.
get(resource_group_name: str, account_name: str, queue_name: str, **kwargs: Any) -> StorageQueue
Параметры
- resource_group_name
- str
Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается. Обязательный.
- account_name
- str
Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра. Обязательный.
- queue_name
- str
Имя очереди должно быть уникальным в пределах учетной записи хранения и содержать от 3 до 63 символов. Имя должно состоять только из буквенно-цифровых символов в нижнем регистре и символов dash(-), оно должно начинаться и заканчиваться буквенно-цифровым символом и не может содержать два последовательных символа dash(-). Обязательный.
- cls
- callable
Пользовательский тип или функция, которые будут переданы в прямой ответ.
Возвращаемое значение
StorageQueue или результат cls(response)
Возвращаемый тип
Исключения
list
Возвращает список всех очередей в указанной учетной записи хранения.
list(resource_group_name: str, account_name: str, maxpagesize: str | None = None, filter: str | None = None, **kwargs: Any) -> Iterable[ListQueue]
Параметры
- resource_group_name
- str
Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается. Обязательный.
- account_name
- str
Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра. Обязательный.
- maxpagesize
- str
(необязательно) — максимальное количество очередей, которые должны быть включены в ответ очереди списка. Значение по умолчанию —Нет.
- filter
- str
Необязательный параметр. Если этот параметр указан, будут перечислены только очереди с именем, начинающийся с заданного фильтра. Значение по умолчанию —Нет.
- cls
- callable
Пользовательский тип или функция, которые будут переданы в прямой ответ.
Возвращаемое значение
Итератор, например экземпляр ListQueue или результат cls(response)
Возвращаемый тип
Исключения
update
Создает новую очередь с указанным именем очереди в указанной учетной записи.
update(resource_group_name: str, account_name: str, queue_name: str, queue: _models.StorageQueue, *, content_type: str = 'application/json', **kwargs: Any) -> _models.StorageQueue
Параметры
- resource_group_name
- str
Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается. Обязательный.
- account_name
- str
Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра. Обязательный.
- queue_name
- str
Имя очереди должно быть уникальным в пределах учетной записи хранения и содержать от 3 до 63 символов. Имя должно состоять только из буквенно-цифровых символов в нижнем регистре и символов dash(-), оно должно начинаться и заканчиваться буквенно-цифровым символом и не может содержать два последовательных символа dash(-). Обязательный.
- queue
- StorageQueue или IO
Свойства и метаданные очереди для создания. Тип StorageQueue или тип ввода-вывода. Обязательный.
- content_type
- str
Тип содержимого параметра тела. Известные значения: "application/json". Значение по умолчанию —Нет.
- cls
- callable
Пользовательский тип или функция, которые будут переданы в прямой ответ.
Возвращаемое значение
StorageQueue или результат cls(response)
Возвращаемый тип
Исключения
Атрибуты
models
models = <module 'azure.mgmt.storage.v2020_08_01_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\storage\\v2020_08_01_preview\\models\\__init__.py'>
Azure SDK for Python