QueueServicesOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

StorageManagementClient's

<xref:queue_services> attribute.

Inheritance
builtins.object
QueueServicesOperations

Constructor

QueueServicesOperations(*args, **kwargs)

Methods

get_service_properties

Gets the properties of a storage account's Queue service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
list

List all queue services for the storage account.
set_service_properties

Sets the properties of a storage account's Queue service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.

get_service_properties

Gets the properties of a storage account's Queue service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.

get_service_properties(resource_group_name: str, account_name: str, queue_service_name: str | Enum31, **kwargs: Any) -> QueueServiceProperties

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the user's subscription. The name is case insensitive. Required.
account_name
Required
str

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.
queue_service_name
Required
str or Enum31

The name of the Queue Service within the specified storage account. Queue Service Name must be 'default'. "default" Required.

Returns

Type Description
QueueServiceProperties

QueueServiceProperties or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

List all queue services for the storage account.

list(resource_group_name: str, account_name: str, **kwargs: Any) -> ListQueueServices

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the user's subscription. The name is case insensitive. Required.
account_name
Required
str

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.

Returns

Type Description
ListQueueServices

ListQueueServices or the result of cls(response)

Exceptions

Type Description
HttpResponseError

set_service_properties

Sets the properties of a storage account's Queue service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.

set_service_properties(resource_group_name: str, account_name: str, queue_service_name: str | _models.Enum31, parameters: _models.QueueServiceProperties, *, content_type: str = 'application/json', **kwargs: Any) -> _models.QueueServiceProperties

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the user's subscription. The name is case insensitive. Required.
account_name
Required
str

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.
queue_service_name
Required
str or Enum31

The name of the Queue Service within the specified storage account. Queue Service Name must be 'default'. "default" Required.
parameters
Required
QueueServiceProperties or IO[bytes]

The properties of a storage account's Queue service, only properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules can be specified. Is either a QueueServiceProperties type or a IO[bytes] type. Required.

Returns

Type Description
QueueServiceProperties

QueueServiceProperties or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.storage.v2021_02_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\storage\\v2021_02_01\\models\\__init__.py'>