azure.mgmt.storagecache.models module

class azure.mgmt.storagecache.models.ApiOperation(*, display=None, name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

REST API operation description: see https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/openapi-authoring-automated-guidelines.md#r3023-operationsapiimplementation.

Parameters

  • display (ApiOperationDisplay) – The object that represents the operation.

  • name (str) – Operation name: {provider}/{resource}/{operation}

class azure.mgmt.storagecache.models.ApiOperationDisplay(*, operation: str = None, provider: str = None, resource: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The object that represents the operation.

Parameters

  • operation (str) – Operation type: Read, write, delete, etc.

  • provider (str) – Service provider: Microsoft.StorageCache

  • resource (str) – Resource on which the operation is performed: Cache, etc.

class azure.mgmt.storagecache.models.Cache(*, tags=None, location: str = None, identity=None, cache_size_gb: int = None, provisioning_state=None, subnet: str = None, upgrade_status=None, network_settings=None, encryption_settings=None, security_settings=None, sku=None, **kwargs)[source]

Bases: msrest.serialization.Model

A Cache instance. Follows Azure Resource Manager standards: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters
Variables

  • id (str) – Resource ID of the Cache.

  • name (str) – Name of Cache.

  • type (str) – Type of the Cache; Microsoft.StorageCache/Cache

  • health (CacheHealth) – Health of the Cache.

  • mount_addresses (list[str]) – Array of IP addresses that can be used by clients mounting this Cache.

class azure.mgmt.storagecache.models.CacheEncryptionSettings(*, key_encryption_key=None, **kwargs)[source]

Bases: msrest.serialization.Model

Cache encryption settings.

Parameters

key_encryption_key (KeyVaultKeyReference) – Specifies the location of the key encryption key in Key Vault.

class azure.mgmt.storagecache.models.CacheHealth(*, state=None, status_description: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

An indication of Cache health. Gives more information about health than just that related to provisioning.

Parameters

  • state (str or HealthStateType) – List of Cache health states. Possible values include: ‘Unknown’, ‘Healthy’, ‘Degraded’, ‘Down’, ‘Transitioning’, ‘Stopping’, ‘Stopped’, ‘Upgrading’, ‘Flushing’

  • status_description (str) – Describes explanation of state.

class azure.mgmt.storagecache.models.CacheIdentity(*, type=None, **kwargs)[source]

Bases: msrest.serialization.Model

Cache identity properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • principal_id (str) – The principal id of the cache.

  • tenant_id (str) – The tenant id associated with the cache.

Parameters

type (str or CacheIdentityType) – The type of identity used for the cache. Possible values include: ‘SystemAssigned’, ‘None’

class azure.mgmt.storagecache.models.CacheNetworkSettings(*, mtu: int = 1500, **kwargs)[source]

Bases: msrest.serialization.Model

Cache network settings.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

mtu (int) – The IPv4 maximum transmission unit configured for the subnet. Default value: 1500 .

Variables

utility_addresses (list[str]) – Array of additional IP addresses used by this Cache.

class azure.mgmt.storagecache.models.CacheSecuritySettings(*, root_squash: bool = None, **kwargs)[source]

Bases: msrest.serialization.Model

Cache security settings.

Parameters

root_squash (bool) – root squash of cache property.

class azure.mgmt.storagecache.models.CacheSku(*, name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

SKU for the Cache.

Parameters

name (str) – SKU name for this Cache.

class azure.mgmt.storagecache.models.CacheUpgradeStatus(**kwargs)[source]

Bases: msrest.serialization.Model

Properties describing the software upgrade state of the Cache.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • current_firmware_version (str) – Version string of the firmware currently installed on this Cache.

  • firmware_update_status (str or FirmwareStatusType) – True if there is a firmware update ready to install on this Cache. The firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation. Possible values include: ‘available’, ‘unavailable’

  • firmware_update_deadline (datetime) – Time at which the pending firmware update will automatically be installed on the Cache.

  • last_firmware_update (datetime) – Time of the last successful firmware update.

  • pending_firmware_version (str) – When firmwareUpdateAvailable is true, this field holds the version string for the update.

class azure.mgmt.storagecache.models.ClfsTarget(*, target: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Properties pertained to ClfsTarget.

Parameters

target (str) – Resource ID of storage container.

class azure.mgmt.storagecache.models.ClfsTargetProperties(*, junctions=None, target_type: str = None, provisioning_state=None, nfs3=None, clfs=None, unknown=None, **kwargs)[source]

Bases: azure.mgmt.storagecache.models._models_py3.StorageTargetProperties

Storage container for use as a CLFS Storage Target.

All required parameters must be populated in order to send to Azure.

Parameters
class azure.mgmt.storagecache.models.CloudErrorBody(*, code: str = None, details=None, message: str = None, target: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

An error response.

Parameters

  • code (str) – An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

  • details (list[CloudErrorBody]) – A list of additional details about the error.

  • message (str) – A message describing the error, intended to be suitable for display in a user interface.

  • target (str) – The target of the particular error. For example, the name of the property in error.

class azure.mgmt.storagecache.models.KeyVaultKeyReference(*, key_url: str, source_vault, **kwargs)[source]

Bases: msrest.serialization.Model

Describes a reference to Key Vault Key.

All required parameters must be populated in order to send to Azure.

Parameters

  • key_url (str) – Required. The URL referencing a key encryption key in Key Vault.

  • source_vault (KeyVaultKeyReferenceSourceVault) – Required. Describes a resource Id to source Key Vault.

class azure.mgmt.storagecache.models.KeyVaultKeyReferenceSourceVault(*, id: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Describes a resource Id to source Key Vault.

Parameters

id (str) – Resource Id.

class azure.mgmt.storagecache.models.NamespaceJunction(*, namespace_path: str = None, target_path: str = None, nfs_export: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

A namespace junction.

Parameters

  • namespace_path (str) – Namespace path on a Cache for a Storage Target.

  • target_path (str) – Path in Storage Target to which namespacePath points.

  • nfs_export (str) – NFS export where targetPath exists.

class azure.mgmt.storagecache.models.Nfs3Target(*, target: str = None, usage_model: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Properties pertained to Nfs3Target.

Parameters

  • target (str) – IP address or host name of an NFSv3 host (e.g., 10.0.44.44).

  • usage_model (str) – Identifies the primary usage model to be used for this Storage Target. Get choices from …/usageModels

class azure.mgmt.storagecache.models.Nfs3TargetProperties(*, junctions=None, target_type: str = None, provisioning_state=None, nfs3=None, clfs=None, unknown=None, **kwargs)[source]

Bases: azure.mgmt.storagecache.models._models_py3.StorageTargetProperties

An NFSv3 mount point for use as a Storage Target.

All required parameters must be populated in order to send to Azure.

Parameters
class azure.mgmt.storagecache.models.ResourceSku(*, capabilities=None, location_info=None, name: str = None, restrictions=None, **kwargs)[source]

Bases: msrest.serialization.Model

A resource SKU.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • resource_type (str) – The type of resource the SKU applies to.

  • locations (list[str]) – The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g., West US, East US, Southeast Asia, etc.).

Parameters

  • capabilities (list[ResourceSkuCapabilities]) – A list of capabilities of this SKU, such as throughput or ops/sec.

  • location_info (list[ResourceSkuLocationInfo]) – The set of locations that the SKU is available.

  • name (str) – The name of this SKU.

  • restrictions (list[Restriction]) – The restrictions preventing this SKU from being used. This is empty if there are no restrictions.

class azure.mgmt.storagecache.models.ResourceSkuCapabilities(*, name: str = None, value: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

A resource SKU capability.

Parameters

  • name (str) – Name of a capability, such as ops/sec.

  • value (str) – Quantity, if the capability is measured by quantity.

class azure.mgmt.storagecache.models.ResourceSkuLocationInfo(*, location: str = None, zones=None, **kwargs)[source]

Bases: msrest.serialization.Model

Resource SKU location information.

Parameters

  • location (str) – Location where this SKU is available.

  • zones (list[str]) – Zones if any.

class azure.mgmt.storagecache.models.Restriction(*, reason_code=None, **kwargs)[source]

Bases: msrest.serialization.Model

The restrictions preventing this SKU from being used.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • type (str) – The type of restrictions. In this version, the only possible value for this is location.

  • values (list[str]) – The value of restrictions. If the restriction type is set to location, then this would be the different locations where the SKU is restricted.

Parameters

reason_code (str or ReasonCode) – The reason for the restriction. As of now this can be “QuotaId” or “NotAvailableForSubscription”. “QuotaId” is set when the SKU has requiredQuotas parameter as the subscription does not belong to that quota. “NotAvailableForSubscription” is related to capacity at the datacenter. Possible values include: ‘QuotaId’, ‘NotAvailableForSubscription’

class azure.mgmt.storagecache.models.StorageTarget(*, junctions=None, target_type: str = None, provisioning_state=None, nfs3=None, clfs=None, unknown=None, **kwargs)[source]

Bases: azure.mgmt.storagecache.models._models_py3.StorageTargetResource

Type of the Storage Target.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • name (str) – Name of the Storage Target.

  • id (str) – Resource ID of the Storage Target.

  • type (str) – Type of the Storage Target; Microsoft.StorageCache/Cache/StorageTarget

Parameters
class azure.mgmt.storagecache.models.StorageTargetProperties(*, junctions=None, target_type: str = None, provisioning_state=None, nfs3=None, clfs=None, unknown=None, **kwargs)[source]

Bases: msrest.serialization.Model

Properties of the Storage Target.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: Nfs3TargetProperties, ClfsTargetProperties, UnknownTargetProperties

All required parameters must be populated in order to send to Azure.

Parameters
class azure.mgmt.storagecache.models.StorageTargetResource(**kwargs)[source]

Bases: msrest.serialization.Model

Resource used by a Cache.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • name (str) – Name of the Storage Target.

  • id (str) – Resource ID of the Storage Target.

  • type (str) – Type of the Storage Target; Microsoft.StorageCache/Cache/StorageTarget

class azure.mgmt.storagecache.models.UnknownTarget(*, unknown_map=None, **kwargs)[source]

Bases: msrest.serialization.Model

Properties pertained to UnknownTarget.

Parameters

unknown_map (dict[str, str]) – Dictionary of string->string pairs containing information about the Storage Target.

class azure.mgmt.storagecache.models.UnknownTargetProperties(*, junctions=None, target_type: str = None, provisioning_state=None, nfs3=None, clfs=None, unknown=None, **kwargs)[source]

Bases: azure.mgmt.storagecache.models._models_py3.StorageTargetProperties

Storage container for use as an Unknown Storage Target.

All required parameters must be populated in order to send to Azure.

Parameters
class azure.mgmt.storagecache.models.UsageModel(*, display=None, model_name: str = None, target_type: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

A usage model.

Parameters

  • display (UsageModelDisplay) – Localized information describing this usage model.

  • model_name (str) – Non-localized keyword name for this usage model.

  • target_type (str) – The type of Storage Target to which this model is applicable (only nfs3 as of this version).

class azure.mgmt.storagecache.models.UsageModelDisplay(*, description: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Localized information describing this usage model.

Parameters

description (str) – String to display for this usage model.

class azure.mgmt.storagecache.models.ApiOperationPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ApiOperation object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.storagecache.models.ResourceSkuPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ResourceSku object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.storagecache.models.UsageModelPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of UsageModel object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.storagecache.models.CachePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Cache object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.storagecache.models.StorageTargetPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of StorageTarget object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.storagecache.models.CacheIdentityType[source]

Bases: str, enum.Enum

An enumeration.

none = 'None'
system_assigned = 'SystemAssigned'
class azure.mgmt.storagecache.models.HealthStateType[source]

Bases: str, enum.Enum

An enumeration.

degraded = 'Degraded'
down = 'Down'
flushing = 'Flushing'
healthy = 'Healthy'
stopped = 'Stopped'
stopping = 'Stopping'
transitioning = 'Transitioning'
unknown = 'Unknown'
upgrading = 'Upgrading'
class azure.mgmt.storagecache.models.ProvisioningStateType[source]

Bases: str, enum.Enum

An enumeration.

cancelled = 'Cancelled'
creating = 'Creating'
deleting = 'Deleting'
failed = 'Failed'
succeeded = 'Succeeded'
updating = 'Updating'
class azure.mgmt.storagecache.models.FirmwareStatusType[source]

Bases: str, enum.Enum

An enumeration.

available = 'available'
unavailable = 'unavailable'
class azure.mgmt.storagecache.models.StorageTargetType[source]

Bases: str, enum.Enum

An enumeration.

clfs = 'clfs'
nfs3 = 'nfs3'
unknown = 'unknown'
class azure.mgmt.storagecache.models.ReasonCode[source]

Bases: str, enum.Enum

An enumeration.

not_available_for_subscription = 'NotAvailableForSubscription'
quota_id = 'QuotaId'