azure.mgmt.storagecache.operations module

class azure.mgmt.storagecache.operations.Operations(client, config, serializer, deserializer)[source]

Bases: object

Operations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2020-03-01”.

list(custom_headers=None, raw=False, **operation_config)[source]

Lists all of the available Resource Provider operations.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of ApiOperation

Return type

ApiOperationPaged[ApiOperation]

Raises

CloudError

models = <module 'azure.mgmt.storagecache.models' from '/home/vsts/work/1/s/sdk/storage/azure-mgmt-storagecache/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/storagecache/models/__init__.py'>
class azure.mgmt.storagecache.operations.SkusOperations(client, config, serializer, deserializer)[source]

Bases: object

SkusOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2020-03-01”.

list(custom_headers=None, raw=False, **operation_config)[source]

Get the list of StorageCache.Cache SKUs available to this subscription.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of ResourceSku

Return type

ResourceSkuPaged[ResourceSku]

Raises

CloudError

models = <module 'azure.mgmt.storagecache.models' from '/home/vsts/work/1/s/sdk/storage/azure-mgmt-storagecache/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/storagecache/models/__init__.py'>
class azure.mgmt.storagecache.operations.UsageModelsOperations(client, config, serializer, deserializer)[source]

Bases: object

UsageModelsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2020-03-01”.

list(custom_headers=None, raw=False, **operation_config)[source]

Get the list of Cache Usage Models available to this subscription.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of UsageModel

Return type

UsageModelPaged[UsageModel]

Raises

CloudError

models = <module 'azure.mgmt.storagecache.models' from '/home/vsts/work/1/s/sdk/storage/azure-mgmt-storagecache/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/storagecache/models/__init__.py'>
class azure.mgmt.storagecache.operations.CachesOperations(client, config, serializer, deserializer)[source]

Bases: object

CachesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2020-03-01”.

create_or_update(resource_group_name, cache_name, cache=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Create or update a Cache.

Parameters

  • resource_group_name (str) – Target resource group.

  • cache_name (str) – Name of Cache. Length of name must be not greater than 80 and chars must be in list of [-0-9a-zA-Z_] char class.

  • cache (Cache) – Object containing the user-selectable properties of the new Cache. If read-only properties are included, they must match the existing values of those properties.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Cache or ClientRawResponse<Cache> if raw==True

Return type

AzureOperationPoller[Cache] or AzureOperationPoller[ClientRawResponse[Cache]]

Raises

CloudError

delete(resource_group_name, cache_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Schedules a Cache for deletion.

Parameters

  • resource_group_name (str) – Target resource group.

  • cache_name (str) – Name of Cache. Length of name must be not greater than 80 and chars must be in list of [-0-9a-zA-Z_] char class.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns object or ClientRawResponse<object> if raw==True

Return type

AzureOperationPoller[object] or AzureOperationPoller[ClientRawResponse[object]]

Raises

CloudError

flush(resource_group_name, cache_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Tells a Cache to write all dirty data to the Storage Target(s). During the flush, clients will see errors returned until the flush is complete.

Parameters

  • resource_group_name (str) – Target resource group.

  • cache_name (str) – Name of Cache. Length of name must be not greater than 80 and chars must be in list of [-0-9a-zA-Z_] char class.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns object or ClientRawResponse<object> if raw==True

Return type

AzureOperationPoller[object] or AzureOperationPoller[ClientRawResponse[object]]

Raises

CloudError

get(resource_group_name, cache_name, custom_headers=None, raw=False, **operation_config)[source]

Returns a Cache.

Parameters

  • resource_group_name (str) – Target resource group.

  • cache_name (str) – Name of Cache. Length of name must be not greater than 80 and chars must be in list of [-0-9a-zA-Z_] char class.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Cache or ClientRawResponse if raw=true

Return type

Cache or ClientRawResponse

Raises

CloudError

list(custom_headers=None, raw=False, **operation_config)[source]

Returns all Caches the user has access to under a subscription.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of Cache

Return type

CachePaged[Cache]

Raises

CloudError

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Returns all Caches the user has access to under a resource group.

Parameters

  • resource_group_name (str) – Target resource group.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of Cache

Return type

CachePaged[Cache]

Raises

CloudError

start(resource_group_name, cache_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Tells a Stopped state Cache to transition to Active state.

Parameters

  • resource_group_name (str) – Target resource group.

  • cache_name (str) – Name of Cache. Length of name must be not greater than 80 and chars must be in list of [-0-9a-zA-Z_] char class.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns object or ClientRawResponse<object> if raw==True

Return type

AzureOperationPoller[object] or AzureOperationPoller[ClientRawResponse[object]]

Raises

CloudError

stop(resource_group_name, cache_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Tells an Active Cache to transition to Stopped state.

Parameters

  • resource_group_name (str) – Target resource group.

  • cache_name (str) – Name of Cache. Length of name must be not greater than 80 and chars must be in list of [-0-9a-zA-Z_] char class.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns object or ClientRawResponse<object> if raw==True

Return type

AzureOperationPoller[object] or AzureOperationPoller[ClientRawResponse[object]]

Raises

CloudError

update(resource_group_name, cache_name, cache=None, custom_headers=None, raw=False, **operation_config)[source]

Update a Cache instance.

Parameters

  • resource_group_name (str) – Target resource group.

  • cache_name (str) – Name of Cache. Length of name must be not greater than 80 and chars must be in list of [-0-9a-zA-Z_] char class.

  • cache (Cache) – Object containing the user-selectable properties of the Cache. If read-only properties are included, they must match the existing values of those properties.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Cache or ClientRawResponse if raw=true

Return type

Cache or ClientRawResponse

Raises

CloudError

upgrade_firmware(resource_group_name, cache_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Upgrade a Cache’s firmware if a new version is available. Otherwise, this operation has no effect.

Parameters

  • resource_group_name (str) – Target resource group.

  • cache_name (str) – Name of Cache. Length of name must be not greater than 80 and chars must be in list of [-0-9a-zA-Z_] char class.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns object or ClientRawResponse<object> if raw==True

Return type

AzureOperationPoller[object] or AzureOperationPoller[ClientRawResponse[object]]

Raises

CloudError

models = <module 'azure.mgmt.storagecache.models' from '/home/vsts/work/1/s/sdk/storage/azure-mgmt-storagecache/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/storagecache/models/__init__.py'>
class azure.mgmt.storagecache.operations.StorageTargetsOperations(client, config, serializer, deserializer)[source]

Bases: object

StorageTargetsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client API version. Constant value: “2020-03-01”.

create_or_update(resource_group_name, cache_name, storage_target_name, storagetarget=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Create or update a Storage Target. This operation is allowed at any time, but if the Cache is down or unhealthy, the actual creation/modification of the Storage Target may be delayed until the Cache is healthy again.

Parameters

  • resource_group_name (str) – Target resource group.

  • cache_name (str) – Name of Cache. Length of name must be not greater than 80 and chars must be in list of [-0-9a-zA-Z_] char class.

  • storage_target_name (str) – Name of the Storage Target. Length of name must be not greater than 80 and chars must be in list of [-0-9a-zA-Z_] char class.

  • storagetarget (StorageTarget) – Object containing the definition of a Storage Target.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns StorageTarget or ClientRawResponse<StorageTarget> if raw==True

Return type

AzureOperationPoller[StorageTarget] or AzureOperationPoller[ClientRawResponse[StorageTarget]]

Raises

CloudError

delete(resource_group_name, cache_name, storage_target_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Removes a Storage Target from a Cache. This operation is allowed at any time, but if the Cache is down or unhealthy, the actual removal of the Storage Target may be delayed until the Cache is healthy again. Note that if the Cache has data to flush to the Storage Target, the data will be flushed before the Storage Target will be deleted.

Parameters

  • resource_group_name (str) – Target resource group.

  • cache_name (str) – Name of Cache. Length of name must be not greater than 80 and chars must be in list of [-0-9a-zA-Z_] char class.

  • storage_target_name (str) – Name of Storage Target.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns object or ClientRawResponse<object> if raw==True

Return type

AzureOperationPoller[object] or AzureOperationPoller[ClientRawResponse[object]]

Raises

CloudError

get(resource_group_name, cache_name, storage_target_name, custom_headers=None, raw=False, **operation_config)[source]

Returns a Storage Target from a Cache.

Parameters

  • resource_group_name (str) – Target resource group.

  • cache_name (str) – Name of Cache. Length of name must be not greater than 80 and chars must be in list of [-0-9a-zA-Z_] char class.

  • storage_target_name (str) – Name of the Storage Target. Length of name must be not greater than 80 and chars must be in list of [-0-9a-zA-Z_] char class.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

StorageTarget or ClientRawResponse if raw=true

Return type

StorageTarget or ClientRawResponse

Raises

CloudError

list_by_cache(resource_group_name, cache_name, custom_headers=None, raw=False, **operation_config)[source]

Returns a list of Storage Targets for the specified Cache.

Parameters

  • resource_group_name (str) – Target resource group.

  • cache_name (str) – Name of Cache. Length of name must be not greater than 80 and chars must be in list of [-0-9a-zA-Z_] char class.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of StorageTarget

Return type

StorageTargetPaged[StorageTarget]

Raises

CloudError

models = <module 'azure.mgmt.storagecache.models' from '/home/vsts/work/1/s/sdk/storage/azure-mgmt-storagecache/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/storagecache/models/__init__.py'>