# coding=utf-8
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
#
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is
# regenerated.
# --------------------------------------------------------------------------
from msrest.serialization import Model
[docs]class AccountSasParameters(Model):
"""The parameters to list SAS credentials of a storage account.
All required parameters must be populated in order to send to Azure.
:param services: Required. The signed services accessible with the account
SAS. Possible values include: Blob (b), Queue (q), Table (t), File (f).
Possible values include: 'b', 'q', 't', 'f'
:type services: str or ~azure.mgmt.storage.v2018_02_01.models.Services
:param resource_types: Required. The signed resource types that are
accessible with the account SAS. Service (s): Access to service-level
APIs; Container (c): Access to container-level APIs; Object (o): Access to
object-level APIs for blobs, queue messages, table entities, and files.
Possible values include: 's', 'c', 'o'
:type resource_types: str or
~azure.mgmt.storage.v2018_02_01.models.SignedResourceTypes
:param permissions: Required. The signed permissions for the account SAS.
Possible values include: Read (r), Write (w), Delete (d), List (l), Add
(a), Create (c), Update (u) and Process (p). Possible values include: 'r',
'd', 'w', 'l', 'a', 'c', 'u', 'p'
:type permissions: str or
~azure.mgmt.storage.v2018_02_01.models.Permissions
:param ip_address_or_range: An IP address or a range of IP addresses from
which to accept requests.
:type ip_address_or_range: str
:param protocols: The protocol permitted for a request made with the
account SAS. Possible values include: 'https,http', 'https'
:type protocols: str or
~azure.mgmt.storage.v2018_02_01.models.HttpProtocol
:param shared_access_start_time: The time at which the SAS becomes valid.
:type shared_access_start_time: datetime
:param shared_access_expiry_time: Required. The time at which the shared
access signature becomes invalid.
:type shared_access_expiry_time: datetime
:param key_to_sign: The key to sign the account SAS token with.
:type key_to_sign: str
"""
_validation = {
'services': {'required': True},
'resource_types': {'required': True},
'permissions': {'required': True},
'shared_access_expiry_time': {'required': True},
}
_attribute_map = {
'services': {'key': 'signedServices', 'type': 'str'},
'resource_types': {'key': 'signedResourceTypes', 'type': 'str'},
'permissions': {'key': 'signedPermission', 'type': 'str'},
'ip_address_or_range': {'key': 'signedIp', 'type': 'str'},
'protocols': {'key': 'signedProtocol', 'type': 'HttpProtocol'},
'shared_access_start_time': {'key': 'signedStart', 'type': 'iso-8601'},
'shared_access_expiry_time': {'key': 'signedExpiry', 'type': 'iso-8601'},
'key_to_sign': {'key': 'keyToSign', 'type': 'str'},
}
def __init__(self, *, services, resource_types, permissions, shared_access_expiry_time, ip_address_or_range: str=None, protocols=None, shared_access_start_time=None, key_to_sign: str=None, **kwargs) -> None:
super(AccountSasParameters, self).__init__(**kwargs)
self.services = services
self.resource_types = resource_types
self.permissions = permissions
self.ip_address_or_range = ip_address_or_range
self.protocols = protocols
self.shared_access_start_time = shared_access_start_time
self.shared_access_expiry_time = shared_access_expiry_time
self.key_to_sign = key_to_sign
[docs]class Resource(Model):
"""Resource.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar id: Fully qualified resource Id for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
:vartype id: str
:ivar name: The name of the resource
:vartype name: str
:ivar type: The type of the resource. Ex-
Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
:vartype type: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(Resource, self).__init__(**kwargs)
self.id = None
self.name = None
self.type = None
[docs]class AzureEntityResource(Resource):
"""The resource model definition for a Azure Resource Manager resource with an
etag.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar id: Fully qualified resource Id for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
:vartype id: str
:ivar name: The name of the resource
:vartype name: str
:ivar type: The type of the resource. Ex-
Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
:vartype type: str
:ivar etag: Resource Etag.
:vartype etag: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'etag': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'etag': {'key': 'etag', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(AzureEntityResource, self).__init__(**kwargs)
self.etag = None
[docs]class BlobContainer(AzureEntityResource):
"""Properties of the blob container, including Id, resource name, resource
type, Etag.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar id: Fully qualified resource Id for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
:vartype id: str
:ivar name: The name of the resource
:vartype name: str
:ivar type: The type of the resource. Ex-
Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
:vartype type: str
:ivar etag: Resource Etag.
:vartype etag: str
:param public_access: Specifies whether data in the container may be
accessed publicly and the level of access. Possible values include:
'Container', 'Blob', 'None'
:type public_access: str or
~azure.mgmt.storage.v2018_02_01.models.PublicAccess
:ivar last_modified_time: Returns the date and time the container was last
modified.
:vartype last_modified_time: datetime
:ivar lease_status: The lease status of the container. Possible values
include: 'Locked', 'Unlocked'
:vartype lease_status: str or
~azure.mgmt.storage.v2018_02_01.models.LeaseStatus
:ivar lease_state: Lease state of the container. Possible values include:
'Available', 'Leased', 'Expired', 'Breaking', 'Broken'
:vartype lease_state: str or
~azure.mgmt.storage.v2018_02_01.models.LeaseState
:ivar lease_duration: Specifies whether the lease on a container is of
infinite or fixed duration, only when the container is leased. Possible
values include: 'Infinite', 'Fixed'
:vartype lease_duration: str or
~azure.mgmt.storage.v2018_02_01.models.LeaseDuration
:param metadata: A name-value pair to associate with the container as
metadata.
:type metadata: dict[str, str]
:ivar immutability_policy: The ImmutabilityPolicy property of the
container.
:vartype immutability_policy:
~azure.mgmt.storage.v2018_02_01.models.ImmutabilityPolicyProperties
:ivar legal_hold: The LegalHold property of the container.
:vartype legal_hold:
~azure.mgmt.storage.v2018_02_01.models.LegalHoldProperties
:ivar has_legal_hold: The hasLegalHold public property is set to true by
SRP if there are at least one existing tag. The hasLegalHold public
property is set to false by SRP if all existing legal hold tags are
cleared out. There can be a maximum of 1000 blob containers with
hasLegalHold=true for a given account.
:vartype has_legal_hold: bool
:ivar has_immutability_policy: The hasImmutabilityPolicy public property
is set to true by SRP if ImmutabilityPolicy has been created for this
container. The hasImmutabilityPolicy public property is set to false by
SRP if ImmutabilityPolicy has not been created for this container.
:vartype has_immutability_policy: bool
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'etag': {'readonly': True},
'last_modified_time': {'readonly': True},
'lease_status': {'readonly': True},
'lease_state': {'readonly': True},
'lease_duration': {'readonly': True},
'immutability_policy': {'readonly': True},
'legal_hold': {'readonly': True},
'has_legal_hold': {'readonly': True},
'has_immutability_policy': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'etag': {'key': 'etag', 'type': 'str'},
'public_access': {'key': 'properties.publicAccess', 'type': 'PublicAccess'},
'last_modified_time': {'key': 'properties.lastModifiedTime', 'type': 'iso-8601'},
'lease_status': {'key': 'properties.leaseStatus', 'type': 'str'},
'lease_state': {'key': 'properties.leaseState', 'type': 'str'},
'lease_duration': {'key': 'properties.leaseDuration', 'type': 'str'},
'metadata': {'key': 'properties.metadata', 'type': '{str}'},
'immutability_policy': {'key': 'properties.immutabilityPolicy', 'type': 'ImmutabilityPolicyProperties'},
'legal_hold': {'key': 'properties.legalHold', 'type': 'LegalHoldProperties'},
'has_legal_hold': {'key': 'properties.hasLegalHold', 'type': 'bool'},
'has_immutability_policy': {'key': 'properties.hasImmutabilityPolicy', 'type': 'bool'},
}
def __init__(self, *, public_access=None, metadata=None, **kwargs) -> None:
super(BlobContainer, self).__init__(**kwargs)
self.public_access = public_access
self.last_modified_time = None
self.lease_status = None
self.lease_state = None
self.lease_duration = None
self.metadata = metadata
self.immutability_policy = None
self.legal_hold = None
self.has_legal_hold = None
self.has_immutability_policy = None
[docs]class CheckNameAvailabilityResult(Model):
"""The CheckNameAvailability operation response.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar name_available: Gets a boolean value that indicates whether the name
is available for you to use. If true, the name is available. If false, the
name has already been taken or is invalid and cannot be used.
:vartype name_available: bool
:ivar reason: Gets the reason that a storage account name could not be
used. The Reason element is only returned if NameAvailable is false.
Possible values include: 'AccountNameInvalid', 'AlreadyExists'
:vartype reason: str or ~azure.mgmt.storage.v2018_02_01.models.Reason
:ivar message: Gets an error message explaining the Reason value in more
detail.
:vartype message: str
"""
_validation = {
'name_available': {'readonly': True},
'reason': {'readonly': True},
'message': {'readonly': True},
}
_attribute_map = {
'name_available': {'key': 'nameAvailable', 'type': 'bool'},
'reason': {'key': 'reason', 'type': 'Reason'},
'message': {'key': 'message', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(CheckNameAvailabilityResult, self).__init__(**kwargs)
self.name_available = None
self.reason = None
self.message = None
class CloudError(Model):
"""CloudError.
"""
_attribute_map = {
}
[docs]class CustomDomain(Model):
"""The custom domain assigned to this storage account. This can be set via
Update.
All required parameters must be populated in order to send to Azure.
:param name: Required. Gets or sets the custom domain name assigned to the
storage account. Name is the CNAME source.
:type name: str
:param use_sub_domain_name: Indicates whether indirect CName validation is
enabled. Default value is false. This should only be set on updates.
:type use_sub_domain_name: bool
"""
_validation = {
'name': {'required': True},
}
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'use_sub_domain_name': {'key': 'useSubDomainName', 'type': 'bool'},
}
def __init__(self, *, name: str, use_sub_domain_name: bool=None, **kwargs) -> None:
super(CustomDomain, self).__init__(**kwargs)
self.name = name
self.use_sub_domain_name = use_sub_domain_name
[docs]class Dimension(Model):
"""Dimension of blobs, possibly be blob type or access tier.
:param name: Display name of dimension.
:type name: str
:param display_name: Display name of dimension.
:type display_name: str
"""
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'display_name': {'key': 'displayName', 'type': 'str'},
}
def __init__(self, *, name: str=None, display_name: str=None, **kwargs) -> None:
super(Dimension, self).__init__(**kwargs)
self.name = name
self.display_name = display_name
[docs]class Encryption(Model):
"""The encryption settings on the storage account.
All required parameters must be populated in order to send to Azure.
:param services: List of services which support encryption.
:type services: ~azure.mgmt.storage.v2018_02_01.models.EncryptionServices
:param key_source: Required. The encryption keySource (provider). Possible
values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault.
Possible values include: 'Microsoft.Storage', 'Microsoft.Keyvault'.
Default value: "Microsoft.Storage" .
:type key_source: str or ~azure.mgmt.storage.v2018_02_01.models.KeySource
:param key_vault_properties: Properties provided by key vault.
:type key_vault_properties:
~azure.mgmt.storage.v2018_02_01.models.KeyVaultProperties
"""
_validation = {
'key_source': {'required': True},
}
_attribute_map = {
'services': {'key': 'services', 'type': 'EncryptionServices'},
'key_source': {'key': 'keySource', 'type': 'str'},
'key_vault_properties': {'key': 'keyvaultproperties', 'type': 'KeyVaultProperties'},
}
def __init__(self, *, services=None, key_source="Microsoft.Storage", key_vault_properties=None, **kwargs) -> None:
super(Encryption, self).__init__(**kwargs)
self.services = services
self.key_source = key_source
self.key_vault_properties = key_vault_properties
[docs]class EncryptionService(Model):
"""A service that allows server-side encryption to be used.
Variables are only populated by the server, and will be ignored when
sending a request.
:param enabled: A boolean indicating whether or not the service encrypts
the data as it is stored.
:type enabled: bool
:ivar last_enabled_time: Gets a rough estimate of the date/time when the
encryption was last enabled by the user. Only returned when encryption is
enabled. There might be some unencrypted blobs which were written after
this time, as it is just a rough estimate.
:vartype last_enabled_time: datetime
"""
_validation = {
'last_enabled_time': {'readonly': True},
}
_attribute_map = {
'enabled': {'key': 'enabled', 'type': 'bool'},
'last_enabled_time': {'key': 'lastEnabledTime', 'type': 'iso-8601'},
}
def __init__(self, *, enabled: bool=None, **kwargs) -> None:
super(EncryptionService, self).__init__(**kwargs)
self.enabled = enabled
self.last_enabled_time = None
[docs]class EncryptionServices(Model):
"""A list of services that support encryption.
Variables are only populated by the server, and will be ignored when
sending a request.
:param blob: The encryption function of the blob storage service.
:type blob: ~azure.mgmt.storage.v2018_02_01.models.EncryptionService
:param file: The encryption function of the file storage service.
:type file: ~azure.mgmt.storage.v2018_02_01.models.EncryptionService
:ivar table: The encryption function of the table storage service.
:vartype table: ~azure.mgmt.storage.v2018_02_01.models.EncryptionService
:ivar queue: The encryption function of the queue storage service.
:vartype queue: ~azure.mgmt.storage.v2018_02_01.models.EncryptionService
"""
_validation = {
'table': {'readonly': True},
'queue': {'readonly': True},
}
_attribute_map = {
'blob': {'key': 'blob', 'type': 'EncryptionService'},
'file': {'key': 'file', 'type': 'EncryptionService'},
'table': {'key': 'table', 'type': 'EncryptionService'},
'queue': {'key': 'queue', 'type': 'EncryptionService'},
}
def __init__(self, *, blob=None, file=None, **kwargs) -> None:
super(EncryptionServices, self).__init__(**kwargs)
self.blob = blob
self.file = file
self.table = None
self.queue = None
[docs]class Endpoints(Model):
"""The URIs that are used to perform a retrieval of a public blob, queue,
table, web or dfs object.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar blob: Gets the blob endpoint.
:vartype blob: str
:ivar queue: Gets the queue endpoint.
:vartype queue: str
:ivar table: Gets the table endpoint.
:vartype table: str
:ivar file: Gets the file endpoint.
:vartype file: str
:ivar web: Gets the web endpoint.
:vartype web: str
:ivar dfs: Gets the dfs endpoint.
:vartype dfs: str
"""
_validation = {
'blob': {'readonly': True},
'queue': {'readonly': True},
'table': {'readonly': True},
'file': {'readonly': True},
'web': {'readonly': True},
'dfs': {'readonly': True},
}
_attribute_map = {
'blob': {'key': 'blob', 'type': 'str'},
'queue': {'key': 'queue', 'type': 'str'},
'table': {'key': 'table', 'type': 'str'},
'file': {'key': 'file', 'type': 'str'},
'web': {'key': 'web', 'type': 'str'},
'dfs': {'key': 'dfs', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(Endpoints, self).__init__(**kwargs)
self.blob = None
self.queue = None
self.table = None
self.file = None
self.web = None
self.dfs = None
[docs]class Identity(Model):
"""Identity for the resource.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar principal_id: The principal ID of resource identity.
:vartype principal_id: str
:ivar tenant_id: The tenant ID of resource.
:vartype tenant_id: str
:ivar type: Required. The identity type. Default value: "SystemAssigned" .
:vartype type: str
"""
_validation = {
'principal_id': {'readonly': True},
'tenant_id': {'readonly': True},
'type': {'required': True, 'constant': True},
}
_attribute_map = {
'principal_id': {'key': 'principalId', 'type': 'str'},
'tenant_id': {'key': 'tenantId', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
}
type = "SystemAssigned"
def __init__(self, **kwargs) -> None:
super(Identity, self).__init__(**kwargs)
self.principal_id = None
self.tenant_id = None
[docs]class ImmutabilityPolicy(AzureEntityResource):
"""The ImmutabilityPolicy property of a blob container, including Id, resource
name, resource type, Etag.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: Fully qualified resource Id for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
:vartype id: str
:ivar name: The name of the resource
:vartype name: str
:ivar type: The type of the resource. Ex-
Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
:vartype type: str
:ivar etag: Resource Etag.
:vartype etag: str
:param immutability_period_since_creation_in_days: Required. The
immutability period for the blobs in the container since the policy
creation, in days.
:type immutability_period_since_creation_in_days: int
:ivar state: The ImmutabilityPolicy state of a blob container, possible
values include: Locked and Unlocked. Possible values include: 'Locked',
'Unlocked'
:vartype state: str or
~azure.mgmt.storage.v2018_02_01.models.ImmutabilityPolicyState
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'etag': {'readonly': True},
'immutability_period_since_creation_in_days': {'required': True},
'state': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'etag': {'key': 'etag', 'type': 'str'},
'immutability_period_since_creation_in_days': {'key': 'properties.immutabilityPeriodSinceCreationInDays', 'type': 'int'},
'state': {'key': 'properties.state', 'type': 'str'},
}
def __init__(self, *, immutability_period_since_creation_in_days: int, **kwargs) -> None:
super(ImmutabilityPolicy, self).__init__(**kwargs)
self.immutability_period_since_creation_in_days = immutability_period_since_creation_in_days
self.state = None
[docs]class ImmutabilityPolicyProperties(Model):
"""The properties of an ImmutabilityPolicy of a blob container.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:param immutability_period_since_creation_in_days: Required. The
immutability period for the blobs in the container since the policy
creation, in days.
:type immutability_period_since_creation_in_days: int
:ivar state: The ImmutabilityPolicy state of a blob container, possible
values include: Locked and Unlocked. Possible values include: 'Locked',
'Unlocked'
:vartype state: str or
~azure.mgmt.storage.v2018_02_01.models.ImmutabilityPolicyState
:ivar etag: ImmutabilityPolicy Etag.
:vartype etag: str
:ivar update_history: The ImmutabilityPolicy update history of the blob
container.
:vartype update_history:
list[~azure.mgmt.storage.v2018_02_01.models.UpdateHistoryProperty]
"""
_validation = {
'immutability_period_since_creation_in_days': {'required': True},
'state': {'readonly': True},
'etag': {'readonly': True},
'update_history': {'readonly': True},
}
_attribute_map = {
'immutability_period_since_creation_in_days': {'key': 'properties.immutabilityPeriodSinceCreationInDays', 'type': 'int'},
'state': {'key': 'properties.state', 'type': 'str'},
'etag': {'key': 'etag', 'type': 'str'},
'update_history': {'key': 'updateHistory', 'type': '[UpdateHistoryProperty]'},
}
def __init__(self, *, immutability_period_since_creation_in_days: int, **kwargs) -> None:
super(ImmutabilityPolicyProperties, self).__init__(**kwargs)
self.immutability_period_since_creation_in_days = immutability_period_since_creation_in_days
self.state = None
self.etag = None
self.update_history = None
[docs]class IPRule(Model):
"""IP rule with specific IP or IP range in CIDR format.
All required parameters must be populated in order to send to Azure.
:param ip_address_or_range: Required. Specifies the IP or IP range in CIDR
format. Only IPV4 address is allowed.
:type ip_address_or_range: str
:param action: The action of IP ACL rule. Possible values include:
'Allow'. Default value: "Allow" .
:type action: str or ~azure.mgmt.storage.v2018_02_01.models.Action
"""
_validation = {
'ip_address_or_range': {'required': True},
}
_attribute_map = {
'ip_address_or_range': {'key': 'value', 'type': 'str'},
'action': {'key': 'action', 'type': 'Action'},
}
def __init__(self, *, ip_address_or_range: str, action="Allow", **kwargs) -> None:
super(IPRule, self).__init__(**kwargs)
self.ip_address_or_range = ip_address_or_range
self.action = action
[docs]class KeyVaultProperties(Model):
"""Properties of key vault.
:param key_name: The name of KeyVault key.
:type key_name: str
:param key_version: The version of KeyVault key.
:type key_version: str
:param key_vault_uri: The Uri of KeyVault.
:type key_vault_uri: str
"""
_attribute_map = {
'key_name': {'key': 'keyname', 'type': 'str'},
'key_version': {'key': 'keyversion', 'type': 'str'},
'key_vault_uri': {'key': 'keyvaulturi', 'type': 'str'},
}
def __init__(self, *, key_name: str=None, key_version: str=None, key_vault_uri: str=None, **kwargs) -> None:
super(KeyVaultProperties, self).__init__(**kwargs)
self.key_name = key_name
self.key_version = key_version
self.key_vault_uri = key_vault_uri
[docs]class LeaseContainerRequest(Model):
"""Lease Container request schema.
All required parameters must be populated in order to send to Azure.
:param action: Required. Specifies the lease action. Can be one of the
available actions. Possible values include: 'Acquire', 'Renew', 'Change',
'Release', 'Break'
:type action: str or ~azure.mgmt.storage.v2018_02_01.models.enum
:param lease_id: Identifies the lease. Can be specified in any valid GUID
string format.
:type lease_id: str
:param break_period: Optional. For a break action, proposed duration the
lease should continue before it is broken, in seconds, between 0 and 60.
:type break_period: int
:param lease_duration: Required for acquire. Specifies the duration of the
lease, in seconds, or negative one (-1) for a lease that never expires.
:type lease_duration: int
:param proposed_lease_id: Optional for acquire, required for change.
Proposed lease ID, in a GUID string format.
:type proposed_lease_id: str
"""
_validation = {
'action': {'required': True},
}
_attribute_map = {
'action': {'key': 'action', 'type': 'str'},
'lease_id': {'key': 'leaseId', 'type': 'str'},
'break_period': {'key': 'breakPeriod', 'type': 'int'},
'lease_duration': {'key': 'leaseDuration', 'type': 'int'},
'proposed_lease_id': {'key': 'proposedLeaseId', 'type': 'str'},
}
def __init__(self, *, action, lease_id: str=None, break_period: int=None, lease_duration: int=None, proposed_lease_id: str=None, **kwargs) -> None:
super(LeaseContainerRequest, self).__init__(**kwargs)
self.action = action
self.lease_id = lease_id
self.break_period = break_period
self.lease_duration = lease_duration
self.proposed_lease_id = proposed_lease_id
[docs]class LeaseContainerResponse(Model):
"""Lease Container response schema.
:param lease_id: Returned unique lease ID that must be included with any
request to delete the container, or to renew, change, or release the
lease.
:type lease_id: str
:param lease_time_seconds: Approximate time remaining in the lease period,
in seconds.
:type lease_time_seconds: str
"""
_attribute_map = {
'lease_id': {'key': 'leaseId', 'type': 'str'},
'lease_time_seconds': {'key': 'leaseTimeSeconds', 'type': 'str'},
}
def __init__(self, *, lease_id: str=None, lease_time_seconds: str=None, **kwargs) -> None:
super(LeaseContainerResponse, self).__init__(**kwargs)
self.lease_id = lease_id
self.lease_time_seconds = lease_time_seconds
[docs]class LegalHold(Model):
"""The LegalHold property of a blob container.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar has_legal_hold: The hasLegalHold public property is set to true by
SRP if there are at least one existing tag. The hasLegalHold public
property is set to false by SRP if all existing legal hold tags are
cleared out. There can be a maximum of 1000 blob containers with
hasLegalHold=true for a given account.
:vartype has_legal_hold: bool
:param tags: Required. Each tag should be 3 to 23 alphanumeric characters
and is normalized to lower case at SRP.
:type tags: list[str]
"""
_validation = {
'has_legal_hold': {'readonly': True},
'tags': {'required': True},
}
_attribute_map = {
'has_legal_hold': {'key': 'hasLegalHold', 'type': 'bool'},
'tags': {'key': 'tags', 'type': '[str]'},
}
def __init__(self, *, tags, **kwargs) -> None:
super(LegalHold, self).__init__(**kwargs)
self.has_legal_hold = None
self.tags = tags
[docs]class LegalHoldProperties(Model):
"""The LegalHold property of a blob container.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar has_legal_hold: The hasLegalHold public property is set to true by
SRP if there are at least one existing tag. The hasLegalHold public
property is set to false by SRP if all existing legal hold tags are
cleared out. There can be a maximum of 1000 blob containers with
hasLegalHold=true for a given account.
:vartype has_legal_hold: bool
:param tags: The list of LegalHold tags of a blob container.
:type tags: list[~azure.mgmt.storage.v2018_02_01.models.TagProperty]
"""
_validation = {
'has_legal_hold': {'readonly': True},
}
_attribute_map = {
'has_legal_hold': {'key': 'hasLegalHold', 'type': 'bool'},
'tags': {'key': 'tags', 'type': '[TagProperty]'},
}
def __init__(self, *, tags=None, **kwargs) -> None:
super(LegalHoldProperties, self).__init__(**kwargs)
self.has_legal_hold = None
self.tags = tags
[docs]class ListAccountSasResponse(Model):
"""The List SAS credentials operation response.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar account_sas_token: List SAS credentials of storage account.
:vartype account_sas_token: str
"""
_validation = {
'account_sas_token': {'readonly': True},
}
_attribute_map = {
'account_sas_token': {'key': 'accountSasToken', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(ListAccountSasResponse, self).__init__(**kwargs)
self.account_sas_token = None
[docs]class ListContainerItem(AzureEntityResource):
"""The blob container properties be listed out.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar id: Fully qualified resource Id for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
:vartype id: str
:ivar name: The name of the resource
:vartype name: str
:ivar type: The type of the resource. Ex-
Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
:vartype type: str
:ivar etag: Resource Etag.
:vartype etag: str
:param public_access: Specifies whether data in the container may be
accessed publicly and the level of access. Possible values include:
'Container', 'Blob', 'None'
:type public_access: str or
~azure.mgmt.storage.v2018_02_01.models.PublicAccess
:ivar last_modified_time: Returns the date and time the container was last
modified.
:vartype last_modified_time: datetime
:ivar lease_status: The lease status of the container. Possible values
include: 'Locked', 'Unlocked'
:vartype lease_status: str or
~azure.mgmt.storage.v2018_02_01.models.LeaseStatus
:ivar lease_state: Lease state of the container. Possible values include:
'Available', 'Leased', 'Expired', 'Breaking', 'Broken'
:vartype lease_state: str or
~azure.mgmt.storage.v2018_02_01.models.LeaseState
:ivar lease_duration: Specifies whether the lease on a container is of
infinite or fixed duration, only when the container is leased. Possible
values include: 'Infinite', 'Fixed'
:vartype lease_duration: str or
~azure.mgmt.storage.v2018_02_01.models.LeaseDuration
:param metadata: A name-value pair to associate with the container as
metadata.
:type metadata: dict[str, str]
:ivar immutability_policy: The ImmutabilityPolicy property of the
container.
:vartype immutability_policy:
~azure.mgmt.storage.v2018_02_01.models.ImmutabilityPolicyProperties
:ivar legal_hold: The LegalHold property of the container.
:vartype legal_hold:
~azure.mgmt.storage.v2018_02_01.models.LegalHoldProperties
:ivar has_legal_hold: The hasLegalHold public property is set to true by
SRP if there are at least one existing tag. The hasLegalHold public
property is set to false by SRP if all existing legal hold tags are
cleared out. There can be a maximum of 1000 blob containers with
hasLegalHold=true for a given account.
:vartype has_legal_hold: bool
:ivar has_immutability_policy: The hasImmutabilityPolicy public property
is set to true by SRP if ImmutabilityPolicy has been created for this
container. The hasImmutabilityPolicy public property is set to false by
SRP if ImmutabilityPolicy has not been created for this container.
:vartype has_immutability_policy: bool
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'etag': {'readonly': True},
'last_modified_time': {'readonly': True},
'lease_status': {'readonly': True},
'lease_state': {'readonly': True},
'lease_duration': {'readonly': True},
'immutability_policy': {'readonly': True},
'legal_hold': {'readonly': True},
'has_legal_hold': {'readonly': True},
'has_immutability_policy': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'etag': {'key': 'etag', 'type': 'str'},
'public_access': {'key': 'properties.publicAccess', 'type': 'PublicAccess'},
'last_modified_time': {'key': 'properties.lastModifiedTime', 'type': 'iso-8601'},
'lease_status': {'key': 'properties.leaseStatus', 'type': 'str'},
'lease_state': {'key': 'properties.leaseState', 'type': 'str'},
'lease_duration': {'key': 'properties.leaseDuration', 'type': 'str'},
'metadata': {'key': 'properties.metadata', 'type': '{str}'},
'immutability_policy': {'key': 'properties.immutabilityPolicy', 'type': 'ImmutabilityPolicyProperties'},
'legal_hold': {'key': 'properties.legalHold', 'type': 'LegalHoldProperties'},
'has_legal_hold': {'key': 'properties.hasLegalHold', 'type': 'bool'},
'has_immutability_policy': {'key': 'properties.hasImmutabilityPolicy', 'type': 'bool'},
}
def __init__(self, *, public_access=None, metadata=None, **kwargs) -> None:
super(ListContainerItem, self).__init__(**kwargs)
self.public_access = public_access
self.last_modified_time = None
self.lease_status = None
self.lease_state = None
self.lease_duration = None
self.metadata = metadata
self.immutability_policy = None
self.legal_hold = None
self.has_legal_hold = None
self.has_immutability_policy = None
[docs]class ListContainerItems(Model):
"""The list of blob containers.
:param value: The list of blob containers.
:type value:
list[~azure.mgmt.storage.v2018_02_01.models.ListContainerItem]
"""
_attribute_map = {
'value': {'key': 'value', 'type': '[ListContainerItem]'},
}
def __init__(self, *, value=None, **kwargs) -> None:
super(ListContainerItems, self).__init__(**kwargs)
self.value = value
[docs]class ListServiceSasResponse(Model):
"""The List service SAS credentials operation response.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar service_sas_token: List service SAS credentials of specific
resource.
:vartype service_sas_token: str
"""
_validation = {
'service_sas_token': {'readonly': True},
}
_attribute_map = {
'service_sas_token': {'key': 'serviceSasToken', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(ListServiceSasResponse, self).__init__(**kwargs)
self.service_sas_token = None
[docs]class MetricSpecification(Model):
"""Metric specification of operation.
:param name: Name of metric specification.
:type name: str
:param display_name: Display name of metric specification.
:type display_name: str
:param display_description: Display description of metric specification.
:type display_description: str
:param unit: Unit could be Bytes or Count.
:type unit: str
:param dimensions: Dimensions of blobs, including blob type and access
tier.
:type dimensions: list[~azure.mgmt.storage.v2018_02_01.models.Dimension]
:param aggregation_type: Aggregation type could be Average.
:type aggregation_type: str
:param fill_gap_with_zero: The property to decide fill gap with zero or
not.
:type fill_gap_with_zero: bool
:param category: The category this metric specification belong to, could
be Capacity.
:type category: str
:param resource_id_dimension_name_override: Account Resource Id.
:type resource_id_dimension_name_override: str
"""
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'display_name': {'key': 'displayName', 'type': 'str'},
'display_description': {'key': 'displayDescription', 'type': 'str'},
'unit': {'key': 'unit', 'type': 'str'},
'dimensions': {'key': 'dimensions', 'type': '[Dimension]'},
'aggregation_type': {'key': 'aggregationType', 'type': 'str'},
'fill_gap_with_zero': {'key': 'fillGapWithZero', 'type': 'bool'},
'category': {'key': 'category', 'type': 'str'},
'resource_id_dimension_name_override': {'key': 'resourceIdDimensionNameOverride', 'type': 'str'},
}
def __init__(self, *, name: str=None, display_name: str=None, display_description: str=None, unit: str=None, dimensions=None, aggregation_type: str=None, fill_gap_with_zero: bool=None, category: str=None, resource_id_dimension_name_override: str=None, **kwargs) -> None:
super(MetricSpecification, self).__init__(**kwargs)
self.name = name
self.display_name = display_name
self.display_description = display_description
self.unit = unit
self.dimensions = dimensions
self.aggregation_type = aggregation_type
self.fill_gap_with_zero = fill_gap_with_zero
self.category = category
self.resource_id_dimension_name_override = resource_id_dimension_name_override
[docs]class NetworkRuleSet(Model):
"""Network rule set.
All required parameters must be populated in order to send to Azure.
:param bypass: Specifies whether traffic is bypassed for
Logging/Metrics/AzureServices. Possible values are any combination of
Logging|Metrics|AzureServices (For example, "Logging, Metrics"), or None
to bypass none of those traffics. Possible values include: 'None',
'Logging', 'Metrics', 'AzureServices'. Default value: "AzureServices" .
:type bypass: str or ~azure.mgmt.storage.v2018_02_01.models.Bypass
:param virtual_network_rules: Sets the virtual network rules
:type virtual_network_rules:
list[~azure.mgmt.storage.v2018_02_01.models.VirtualNetworkRule]
:param ip_rules: Sets the IP ACL rules
:type ip_rules: list[~azure.mgmt.storage.v2018_02_01.models.IPRule]
:param default_action: Required. Specifies the default action of allow or
deny when no other rules match. Possible values include: 'Allow', 'Deny'.
Default value: "Allow" .
:type default_action: str or
~azure.mgmt.storage.v2018_02_01.models.DefaultAction
"""
_validation = {
'default_action': {'required': True},
}
_attribute_map = {
'bypass': {'key': 'bypass', 'type': 'str'},
'virtual_network_rules': {'key': 'virtualNetworkRules', 'type': '[VirtualNetworkRule]'},
'ip_rules': {'key': 'ipRules', 'type': '[IPRule]'},
'default_action': {'key': 'defaultAction', 'type': 'DefaultAction'},
}
def __init__(self, *, bypass="AzureServices", virtual_network_rules=None, ip_rules=None, default_action="Allow", **kwargs) -> None:
super(NetworkRuleSet, self).__init__(**kwargs)
self.bypass = bypass
self.virtual_network_rules = virtual_network_rules
self.ip_rules = ip_rules
self.default_action = default_action
[docs]class Operation(Model):
"""Storage REST API operation definition.
:param name: Operation name: {provider}/{resource}/{operation}
:type name: str
:param display: Display metadata associated with the operation.
:type display: ~azure.mgmt.storage.v2018_02_01.models.OperationDisplay
:param origin: The origin of operations.
:type origin: str
:param service_specification: One property of operation, include metric
specifications.
:type service_specification:
~azure.mgmt.storage.v2018_02_01.models.ServiceSpecification
"""
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'display': {'key': 'display', 'type': 'OperationDisplay'},
'origin': {'key': 'origin', 'type': 'str'},
'service_specification': {'key': 'properties.serviceSpecification', 'type': 'ServiceSpecification'},
}
def __init__(self, *, name: str=None, display=None, origin: str=None, service_specification=None, **kwargs) -> None:
super(Operation, self).__init__(**kwargs)
self.name = name
self.display = display
self.origin = origin
self.service_specification = service_specification
[docs]class OperationDisplay(Model):
"""Display metadata associated with the operation.
:param provider: Service provider: Microsoft Storage.
:type provider: str
:param resource: Resource on which the operation is performed etc.
:type resource: str
:param operation: Type of operation: get, read, delete, etc.
:type operation: str
:param description: Description of the operation.
:type description: str
"""
_attribute_map = {
'provider': {'key': 'provider', 'type': 'str'},
'resource': {'key': 'resource', 'type': 'str'},
'operation': {'key': 'operation', 'type': 'str'},
'description': {'key': 'description', 'type': 'str'},
}
def __init__(self, *, provider: str=None, resource: str=None, operation: str=None, description: str=None, **kwargs) -> None:
super(OperationDisplay, self).__init__(**kwargs)
self.provider = provider
self.resource = resource
self.operation = operation
self.description = description
[docs]class ProxyResource(Resource):
"""The resource model definition for a ARM proxy resource. It will have
everything other than required location and tags.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar id: Fully qualified resource Id for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
:vartype id: str
:ivar name: The name of the resource
:vartype name: str
:ivar type: The type of the resource. Ex-
Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
:vartype type: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(ProxyResource, self).__init__(**kwargs)
[docs]class Restriction(Model):
"""The restriction because of which SKU cannot be used.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar type: The type of restrictions. As of now only possible value for
this is location.
:vartype type: str
:ivar values: The value of restrictions. If the restriction type is set to
location. This would be different locations where the SKU is restricted.
:vartype values: list[str]
:param reason_code: The reason for the restriction. As of now this can be
"QuotaId" or "NotAvailableForSubscription". Quota Id is set when the SKU
has requiredQuotas parameter as the subscription does not belong to that
quota. The "NotAvailableForSubscription" is related to capacity at DC.
Possible values include: 'QuotaId', 'NotAvailableForSubscription'
:type reason_code: str or
~azure.mgmt.storage.v2018_02_01.models.ReasonCode
"""
_validation = {
'type': {'readonly': True},
'values': {'readonly': True},
}
_attribute_map = {
'type': {'key': 'type', 'type': 'str'},
'values': {'key': 'values', 'type': '[str]'},
'reason_code': {'key': 'reasonCode', 'type': 'str'},
}
def __init__(self, *, reason_code=None, **kwargs) -> None:
super(Restriction, self).__init__(**kwargs)
self.type = None
self.values = None
self.reason_code = reason_code
[docs]class ServiceSasParameters(Model):
"""The parameters to list service SAS credentials of a specific resource.
All required parameters must be populated in order to send to Azure.
:param canonicalized_resource: Required. The canonical path to the signed
resource.
:type canonicalized_resource: str
:param resource: The signed services accessible with the service SAS.
Possible values include: Blob (b), Container (c), File (f), Share (s).
Possible values include: 'b', 'c', 'f', 's'
:type resource: str or
~azure.mgmt.storage.v2018_02_01.models.SignedResource
:param permissions: The signed permissions for the service SAS. Possible
values include: Read (r), Write (w), Delete (d), List (l), Add (a), Create
(c), Update (u) and Process (p). Possible values include: 'r', 'd', 'w',
'l', 'a', 'c', 'u', 'p'
:type permissions: str or
~azure.mgmt.storage.v2018_02_01.models.Permissions
:param ip_address_or_range: An IP address or a range of IP addresses from
which to accept requests.
:type ip_address_or_range: str
:param protocols: The protocol permitted for a request made with the
account SAS. Possible values include: 'https,http', 'https'
:type protocols: str or
~azure.mgmt.storage.v2018_02_01.models.HttpProtocol
:param shared_access_start_time: The time at which the SAS becomes valid.
:type shared_access_start_time: datetime
:param shared_access_expiry_time: The time at which the shared access
signature becomes invalid.
:type shared_access_expiry_time: datetime
:param identifier: A unique value up to 64 characters in length that
correlates to an access policy specified for the container, queue, or
table.
:type identifier: str
:param partition_key_start: The start of partition key.
:type partition_key_start: str
:param partition_key_end: The end of partition key.
:type partition_key_end: str
:param row_key_start: The start of row key.
:type row_key_start: str
:param row_key_end: The end of row key.
:type row_key_end: str
:param key_to_sign: The key to sign the account SAS token with.
:type key_to_sign: str
:param cache_control: The response header override for cache control.
:type cache_control: str
:param content_disposition: The response header override for content
disposition.
:type content_disposition: str
:param content_encoding: The response header override for content
encoding.
:type content_encoding: str
:param content_language: The response header override for content
language.
:type content_language: str
:param content_type: The response header override for content type.
:type content_type: str
"""
_validation = {
'canonicalized_resource': {'required': True},
'identifier': {'max_length': 64},
}
_attribute_map = {
'canonicalized_resource': {'key': 'canonicalizedResource', 'type': 'str'},
'resource': {'key': 'signedResource', 'type': 'str'},
'permissions': {'key': 'signedPermission', 'type': 'str'},
'ip_address_or_range': {'key': 'signedIp', 'type': 'str'},
'protocols': {'key': 'signedProtocol', 'type': 'HttpProtocol'},
'shared_access_start_time': {'key': 'signedStart', 'type': 'iso-8601'},
'shared_access_expiry_time': {'key': 'signedExpiry', 'type': 'iso-8601'},
'identifier': {'key': 'signedIdentifier', 'type': 'str'},
'partition_key_start': {'key': 'startPk', 'type': 'str'},
'partition_key_end': {'key': 'endPk', 'type': 'str'},
'row_key_start': {'key': 'startRk', 'type': 'str'},
'row_key_end': {'key': 'endRk', 'type': 'str'},
'key_to_sign': {'key': 'keyToSign', 'type': 'str'},
'cache_control': {'key': 'rscc', 'type': 'str'},
'content_disposition': {'key': 'rscd', 'type': 'str'},
'content_encoding': {'key': 'rsce', 'type': 'str'},
'content_language': {'key': 'rscl', 'type': 'str'},
'content_type': {'key': 'rsct', 'type': 'str'},
}
def __init__(self, *, canonicalized_resource: str, resource=None, permissions=None, ip_address_or_range: str=None, protocols=None, shared_access_start_time=None, shared_access_expiry_time=None, identifier: str=None, partition_key_start: str=None, partition_key_end: str=None, row_key_start: str=None, row_key_end: str=None, key_to_sign: str=None, cache_control: str=None, content_disposition: str=None, content_encoding: str=None, content_language: str=None, content_type: str=None, **kwargs) -> None:
super(ServiceSasParameters, self).__init__(**kwargs)
self.canonicalized_resource = canonicalized_resource
self.resource = resource
self.permissions = permissions
self.ip_address_or_range = ip_address_or_range
self.protocols = protocols
self.shared_access_start_time = shared_access_start_time
self.shared_access_expiry_time = shared_access_expiry_time
self.identifier = identifier
self.partition_key_start = partition_key_start
self.partition_key_end = partition_key_end
self.row_key_start = row_key_start
self.row_key_end = row_key_end
self.key_to_sign = key_to_sign
self.cache_control = cache_control
self.content_disposition = content_disposition
self.content_encoding = content_encoding
self.content_language = content_language
self.content_type = content_type
[docs]class ServiceSpecification(Model):
"""One property of operation, include metric specifications.
:param metric_specifications: Metric specifications of operation.
:type metric_specifications:
list[~azure.mgmt.storage.v2018_02_01.models.MetricSpecification]
"""
_attribute_map = {
'metric_specifications': {'key': 'metricSpecifications', 'type': '[MetricSpecification]'},
}
def __init__(self, *, metric_specifications=None, **kwargs) -> None:
super(ServiceSpecification, self).__init__(**kwargs)
self.metric_specifications = metric_specifications
[docs]class Sku(Model):
"""The SKU of the storage account.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:param name: Required. Gets or sets the sku name. Required for account
creation; optional for update. Note that in older versions, sku name was
called accountType. Possible values include: 'Standard_LRS',
'Standard_GRS', 'Standard_RAGRS', 'Standard_ZRS', 'Premium_LRS'
:type name: str or ~azure.mgmt.storage.v2018_02_01.models.SkuName
:ivar tier: Gets the sku tier. This is based on the SKU name. Possible
values include: 'Standard', 'Premium'
:vartype tier: str or ~azure.mgmt.storage.v2018_02_01.models.SkuTier
:ivar resource_type: The type of the resource, usually it is
'storageAccounts'.
:vartype resource_type: str
:ivar kind: Indicates the type of storage account. Possible values
include: 'Storage', 'StorageV2', 'BlobStorage'
:vartype kind: str or ~azure.mgmt.storage.v2018_02_01.models.Kind
:ivar locations: 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.).
:vartype locations: list[str]
:ivar capabilities: The capability information in the specified sku,
including file encryption, network acls, change notification, etc.
:vartype capabilities:
list[~azure.mgmt.storage.v2018_02_01.models.SKUCapability]
:param restrictions: The restrictions because of which SKU cannot be used.
This is empty if there are no restrictions.
:type restrictions:
list[~azure.mgmt.storage.v2018_02_01.models.Restriction]
"""
_validation = {
'name': {'required': True},
'tier': {'readonly': True},
'resource_type': {'readonly': True},
'kind': {'readonly': True},
'locations': {'readonly': True},
'capabilities': {'readonly': True},
}
_attribute_map = {
'name': {'key': 'name', 'type': 'SkuName'},
'tier': {'key': 'tier', 'type': 'SkuTier'},
'resource_type': {'key': 'resourceType', 'type': 'str'},
'kind': {'key': 'kind', 'type': 'Kind'},
'locations': {'key': 'locations', 'type': '[str]'},
'capabilities': {'key': 'capabilities', 'type': '[SKUCapability]'},
'restrictions': {'key': 'restrictions', 'type': '[Restriction]'},
}
def __init__(self, *, name, restrictions=None, **kwargs) -> None:
super(Sku, self).__init__(**kwargs)
self.name = name
self.tier = None
self.resource_type = None
self.kind = None
self.locations = None
self.capabilities = None
self.restrictions = restrictions
[docs]class SKUCapability(Model):
"""The capability information in the specified sku, including file encryption,
network acls, change notification, etc.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar name: The name of capability, The capability information in the
specified sku, including file encryption, network acls, change
notification, etc.
:vartype name: str
:ivar value: A string value to indicate states of given capability.
Possibly 'true' or 'false'.
:vartype value: str
"""
_validation = {
'name': {'readonly': True},
'value': {'readonly': True},
}
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'value': {'key': 'value', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(SKUCapability, self).__init__(**kwargs)
self.name = None
self.value = None
[docs]class TrackedResource(Resource):
"""The resource model definition for a ARM tracked top level resource.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: Fully qualified resource Id for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
:vartype id: str
:ivar name: The name of the resource
:vartype name: str
:ivar type: The type of the resource. Ex-
Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
:vartype type: str
:param tags: Resource tags.
:type tags: dict[str, str]
:param location: Required. The geo-location where the resource lives
:type location: str
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'location': {'required': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'location': {'key': 'location', 'type': 'str'},
}
def __init__(self, *, location: str, tags=None, **kwargs) -> None:
super(TrackedResource, self).__init__(**kwargs)
self.tags = tags
self.location = location
[docs]class StorageAccount(TrackedResource):
"""The storage account.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:ivar id: Fully qualified resource Id for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
:vartype id: str
:ivar name: The name of the resource
:vartype name: str
:ivar type: The type of the resource. Ex-
Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
:vartype type: str
:param tags: Resource tags.
:type tags: dict[str, str]
:param location: Required. The geo-location where the resource lives
:type location: str
:ivar sku: Gets the SKU.
:vartype sku: ~azure.mgmt.storage.v2018_02_01.models.Sku
:ivar kind: Gets the Kind. Possible values include: 'Storage',
'StorageV2', 'BlobStorage'
:vartype kind: str or ~azure.mgmt.storage.v2018_02_01.models.Kind
:param identity: The identity of the resource.
:type identity: ~azure.mgmt.storage.v2018_02_01.models.Identity
:ivar provisioning_state: Gets the status of the storage account at the
time the operation was called. Possible values include: 'Creating',
'ResolvingDNS', 'Succeeded'
:vartype provisioning_state: str or
~azure.mgmt.storage.v2018_02_01.models.ProvisioningState
:ivar primary_endpoints: Gets the URLs that are used to perform a
retrieval of a public blob, queue, or table object. Note that Standard_ZRS
and Premium_LRS accounts only return the blob endpoint.
:vartype primary_endpoints:
~azure.mgmt.storage.v2018_02_01.models.Endpoints
:ivar primary_location: Gets the location of the primary data center for
the storage account.
:vartype primary_location: str
:ivar status_of_primary: Gets the status indicating whether the primary
location of the storage account is available or unavailable. Possible
values include: 'available', 'unavailable'
:vartype status_of_primary: str or
~azure.mgmt.storage.v2018_02_01.models.AccountStatus
:ivar last_geo_failover_time: Gets the timestamp of the most recent
instance of a failover to the secondary location. Only the most recent
timestamp is retained. This element is not returned if there has never
been a failover instance. Only available if the accountType is
Standard_GRS or Standard_RAGRS.
:vartype last_geo_failover_time: datetime
:ivar secondary_location: Gets the location of the geo-replicated
secondary for the storage account. Only available if the accountType is
Standard_GRS or Standard_RAGRS.
:vartype secondary_location: str
:ivar status_of_secondary: Gets the status indicating whether the
secondary location of the storage account is available or unavailable.
Only available if the SKU name is Standard_GRS or Standard_RAGRS. Possible
values include: 'available', 'unavailable'
:vartype status_of_secondary: str or
~azure.mgmt.storage.v2018_02_01.models.AccountStatus
:ivar creation_time: Gets the creation date and time of the storage
account in UTC.
:vartype creation_time: datetime
:ivar custom_domain: Gets the custom domain the user assigned to this
storage account.
:vartype custom_domain:
~azure.mgmt.storage.v2018_02_01.models.CustomDomain
:ivar secondary_endpoints: Gets the URLs that are used to perform a
retrieval of a public blob, queue, or table object from the secondary
location of the storage account. Only available if the SKU name is
Standard_RAGRS.
:vartype secondary_endpoints:
~azure.mgmt.storage.v2018_02_01.models.Endpoints
:ivar encryption: Gets the encryption settings on the account. If
unspecified, the account is unencrypted.
:vartype encryption: ~azure.mgmt.storage.v2018_02_01.models.Encryption
:ivar access_tier: Required for storage accounts where kind = BlobStorage.
The access tier used for billing. Possible values include: 'Hot', 'Cool'
:vartype access_tier: str or
~azure.mgmt.storage.v2018_02_01.models.AccessTier
:param enable_https_traffic_only: Allows https traffic only to storage
service if sets to true. Default value: False .
:type enable_https_traffic_only: bool
:ivar network_rule_set: Network rule set
:vartype network_rule_set:
~azure.mgmt.storage.v2018_02_01.models.NetworkRuleSet
:param is_hns_enabled: Account HierarchicalNamespace enabled if sets to
true. Default value: False .
:type is_hns_enabled: bool
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'location': {'required': True},
'sku': {'readonly': True},
'kind': {'readonly': True},
'provisioning_state': {'readonly': True},
'primary_endpoints': {'readonly': True},
'primary_location': {'readonly': True},
'status_of_primary': {'readonly': True},
'last_geo_failover_time': {'readonly': True},
'secondary_location': {'readonly': True},
'status_of_secondary': {'readonly': True},
'creation_time': {'readonly': True},
'custom_domain': {'readonly': True},
'secondary_endpoints': {'readonly': True},
'encryption': {'readonly': True},
'access_tier': {'readonly': True},
'network_rule_set': {'readonly': True},
}
_attribute_map = {
'id': {'key': 'id', 'type': 'str'},
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'location': {'key': 'location', 'type': 'str'},
'sku': {'key': 'sku', 'type': 'Sku'},
'kind': {'key': 'kind', 'type': 'Kind'},
'identity': {'key': 'identity', 'type': 'Identity'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'ProvisioningState'},
'primary_endpoints': {'key': 'properties.primaryEndpoints', 'type': 'Endpoints'},
'primary_location': {'key': 'properties.primaryLocation', 'type': 'str'},
'status_of_primary': {'key': 'properties.statusOfPrimary', 'type': 'AccountStatus'},
'last_geo_failover_time': {'key': 'properties.lastGeoFailoverTime', 'type': 'iso-8601'},
'secondary_location': {'key': 'properties.secondaryLocation', 'type': 'str'},
'status_of_secondary': {'key': 'properties.statusOfSecondary', 'type': 'AccountStatus'},
'creation_time': {'key': 'properties.creationTime', 'type': 'iso-8601'},
'custom_domain': {'key': 'properties.customDomain', 'type': 'CustomDomain'},
'secondary_endpoints': {'key': 'properties.secondaryEndpoints', 'type': 'Endpoints'},
'encryption': {'key': 'properties.encryption', 'type': 'Encryption'},
'access_tier': {'key': 'properties.accessTier', 'type': 'AccessTier'},
'enable_https_traffic_only': {'key': 'properties.supportsHttpsTrafficOnly', 'type': 'bool'},
'network_rule_set': {'key': 'properties.networkAcls', 'type': 'NetworkRuleSet'},
'is_hns_enabled': {'key': 'properties.isHnsEnabled', 'type': 'bool'},
}
def __init__(self, *, location: str, tags=None, identity=None, enable_https_traffic_only: bool=False, is_hns_enabled: bool=False, **kwargs) -> None:
super(StorageAccount, self).__init__(tags=tags, location=location, **kwargs)
self.sku = None
self.kind = None
self.identity = identity
self.provisioning_state = None
self.primary_endpoints = None
self.primary_location = None
self.status_of_primary = None
self.last_geo_failover_time = None
self.secondary_location = None
self.status_of_secondary = None
self.creation_time = None
self.custom_domain = None
self.secondary_endpoints = None
self.encryption = None
self.access_tier = None
self.enable_https_traffic_only = enable_https_traffic_only
self.network_rule_set = None
self.is_hns_enabled = is_hns_enabled
[docs]class StorageAccountCheckNameAvailabilityParameters(Model):
"""The parameters used to check the availability of the storage account name.
Variables are only populated by the server, and will be ignored when
sending a request.
All required parameters must be populated in order to send to Azure.
:param name: Required. The storage account name.
:type name: str
:ivar type: Required. The type of resource,
Microsoft.Storage/storageAccounts. Default value:
"Microsoft.Storage/storageAccounts" .
:vartype type: str
"""
_validation = {
'name': {'required': True},
'type': {'required': True, 'constant': True},
}
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
}
type = "Microsoft.Storage/storageAccounts"
def __init__(self, *, name: str, **kwargs) -> None:
super(StorageAccountCheckNameAvailabilityParameters, self).__init__(**kwargs)
self.name = name
[docs]class StorageAccountCreateParameters(Model):
"""The parameters used when creating a storage account.
All required parameters must be populated in order to send to Azure.
:param sku: Required. Required. Gets or sets the sku name.
:type sku: ~azure.mgmt.storage.v2018_02_01.models.Sku
:param kind: Required. Required. Indicates the type of storage account.
Possible values include: 'Storage', 'StorageV2', 'BlobStorage'
:type kind: str or ~azure.mgmt.storage.v2018_02_01.models.Kind
:param location: Required. Required. Gets or sets the location of the
resource. This will be one of the supported and registered Azure Geo
Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a
resource cannot be changed once it is created, but if an identical geo
region is specified on update, the request will succeed.
:type location: str
:param tags: Gets or sets a list of key value pairs that describe the
resource. These tags can be used for viewing and grouping this resource
(across resource groups). A maximum of 15 tags can be provided for a
resource. Each tag must have a key with a length no greater than 128
characters and a value with a length no greater than 256 characters.
:type tags: dict[str, str]
:param identity: The identity of the resource.
:type identity: ~azure.mgmt.storage.v2018_02_01.models.Identity
:param custom_domain: User domain assigned to the storage account. Name is
the CNAME source. Only one custom domain is supported per storage account
at this time. To clear the existing custom domain, use an empty string for
the custom domain name property.
:type custom_domain: ~azure.mgmt.storage.v2018_02_01.models.CustomDomain
:param encryption: Provides the encryption settings on the account. If
left unspecified the account encryption settings will remain the same. The
default setting is unencrypted.
:type encryption: ~azure.mgmt.storage.v2018_02_01.models.Encryption
:param network_rule_set: Network rule set
:type network_rule_set:
~azure.mgmt.storage.v2018_02_01.models.NetworkRuleSet
:param access_tier: Required for storage accounts where kind =
BlobStorage. The access tier used for billing. Possible values include:
'Hot', 'Cool'
:type access_tier: str or
~azure.mgmt.storage.v2018_02_01.models.AccessTier
:param enable_https_traffic_only: Allows https traffic only to storage
service if sets to true. Default value: False .
:type enable_https_traffic_only: bool
:param is_hns_enabled: Account HierarchicalNamespace enabled if sets to
true. Default value: False .
:type is_hns_enabled: bool
"""
_validation = {
'sku': {'required': True},
'kind': {'required': True},
'location': {'required': True},
}
_attribute_map = {
'sku': {'key': 'sku', 'type': 'Sku'},
'kind': {'key': 'kind', 'type': 'Kind'},
'location': {'key': 'location', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'identity': {'key': 'identity', 'type': 'Identity'},
'custom_domain': {'key': 'properties.customDomain', 'type': 'CustomDomain'},
'encryption': {'key': 'properties.encryption', 'type': 'Encryption'},
'network_rule_set': {'key': 'properties.networkAcls', 'type': 'NetworkRuleSet'},
'access_tier': {'key': 'properties.accessTier', 'type': 'AccessTier'},
'enable_https_traffic_only': {'key': 'properties.supportsHttpsTrafficOnly', 'type': 'bool'},
'is_hns_enabled': {'key': 'properties.isHnsEnabled', 'type': 'bool'},
}
def __init__(self, *, sku, kind, location: str, tags=None, identity=None, custom_domain=None, encryption=None, network_rule_set=None, access_tier=None, enable_https_traffic_only: bool=False, is_hns_enabled: bool=False, **kwargs) -> None:
super(StorageAccountCreateParameters, self).__init__(**kwargs)
self.sku = sku
self.kind = kind
self.location = location
self.tags = tags
self.identity = identity
self.custom_domain = custom_domain
self.encryption = encryption
self.network_rule_set = network_rule_set
self.access_tier = access_tier
self.enable_https_traffic_only = enable_https_traffic_only
self.is_hns_enabled = is_hns_enabled
[docs]class StorageAccountKey(Model):
"""An access key for the storage account.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar key_name: Name of the key.
:vartype key_name: str
:ivar value: Base 64-encoded value of the key.
:vartype value: str
:ivar permissions: Permissions for the key -- read-only or full
permissions. Possible values include: 'Read', 'Full'
:vartype permissions: str or
~azure.mgmt.storage.v2018_02_01.models.KeyPermission
"""
_validation = {
'key_name': {'readonly': True},
'value': {'readonly': True},
'permissions': {'readonly': True},
}
_attribute_map = {
'key_name': {'key': 'keyName', 'type': 'str'},
'value': {'key': 'value', 'type': 'str'},
'permissions': {'key': 'permissions', 'type': 'KeyPermission'},
}
def __init__(self, **kwargs) -> None:
super(StorageAccountKey, self).__init__(**kwargs)
self.key_name = None
self.value = None
self.permissions = None
[docs]class StorageAccountListKeysResult(Model):
"""The response from the ListKeys operation.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar keys: Gets the list of storage account keys and their properties for
the specified storage account.
:vartype keys:
list[~azure.mgmt.storage.v2018_02_01.models.StorageAccountKey]
"""
_validation = {
'keys': {'readonly': True},
}
_attribute_map = {
'keys': {'key': 'keys', 'type': '[StorageAccountKey]'},
}
def __init__(self, **kwargs) -> None:
super(StorageAccountListKeysResult, self).__init__(**kwargs)
self.keys = None
[docs]class StorageAccountRegenerateKeyParameters(Model):
"""The parameters used to regenerate the storage account key.
All required parameters must be populated in order to send to Azure.
:param key_name: Required. The name of storage keys that want to be
regenerated, possible values are key1, key2.
:type key_name: str
"""
_validation = {
'key_name': {'required': True},
}
_attribute_map = {
'key_name': {'key': 'keyName', 'type': 'str'},
}
def __init__(self, *, key_name: str, **kwargs) -> None:
super(StorageAccountRegenerateKeyParameters, self).__init__(**kwargs)
self.key_name = key_name
[docs]class StorageAccountUpdateParameters(Model):
"""The parameters that can be provided when updating the storage account
properties.
:param sku: Gets or sets the SKU name. Note that the SKU name cannot be
updated to Standard_ZRS or Premium_LRS, nor can accounts of those sku
names be updated to any other value.
:type sku: ~azure.mgmt.storage.v2018_02_01.models.Sku
:param tags: Gets or sets a list of key value pairs that describe the
resource. These tags can be used in viewing and grouping this resource
(across resource groups). A maximum of 15 tags can be provided for a
resource. Each tag must have a key no greater in length than 128
characters and a value no greater in length than 256 characters.
:type tags: dict[str, str]
:param identity: The identity of the resource.
:type identity: ~azure.mgmt.storage.v2018_02_01.models.Identity
:param custom_domain: Custom domain assigned to the storage account by the
user. Name is the CNAME source. Only one custom domain is supported per
storage account at this time. To clear the existing custom domain, use an
empty string for the custom domain name property.
:type custom_domain: ~azure.mgmt.storage.v2018_02_01.models.CustomDomain
:param encryption: Provides the encryption settings on the account. The
default setting is unencrypted.
:type encryption: ~azure.mgmt.storage.v2018_02_01.models.Encryption
:param access_tier: Required for storage accounts where kind =
BlobStorage. The access tier used for billing. Possible values include:
'Hot', 'Cool'
:type access_tier: str or
~azure.mgmt.storage.v2018_02_01.models.AccessTier
:param enable_https_traffic_only: Allows https traffic only to storage
service if sets to true. Default value: False .
:type enable_https_traffic_only: bool
:param network_rule_set: Network rule set
:type network_rule_set:
~azure.mgmt.storage.v2018_02_01.models.NetworkRuleSet
:param kind: Optional. Indicates the type of storage account. Currently
only StorageV2 value supported by server. Possible values include:
'Storage', 'StorageV2', 'BlobStorage'
:type kind: str or ~azure.mgmt.storage.v2018_02_01.models.Kind
"""
_attribute_map = {
'sku': {'key': 'sku', 'type': 'Sku'},
'tags': {'key': 'tags', 'type': '{str}'},
'identity': {'key': 'identity', 'type': 'Identity'},
'custom_domain': {'key': 'properties.customDomain', 'type': 'CustomDomain'},
'encryption': {'key': 'properties.encryption', 'type': 'Encryption'},
'access_tier': {'key': 'properties.accessTier', 'type': 'AccessTier'},
'enable_https_traffic_only': {'key': 'properties.supportsHttpsTrafficOnly', 'type': 'bool'},
'network_rule_set': {'key': 'properties.networkAcls', 'type': 'NetworkRuleSet'},
'kind': {'key': 'kind', 'type': 'Kind'},
}
def __init__(self, *, sku=None, tags=None, identity=None, custom_domain=None, encryption=None, access_tier=None, enable_https_traffic_only: bool=False, network_rule_set=None, kind=None, **kwargs) -> None:
super(StorageAccountUpdateParameters, self).__init__(**kwargs)
self.sku = sku
self.tags = tags
self.identity = identity
self.custom_domain = custom_domain
self.encryption = encryption
self.access_tier = access_tier
self.enable_https_traffic_only = enable_https_traffic_only
self.network_rule_set = network_rule_set
self.kind = kind
[docs]class TagProperty(Model):
"""A tag of the LegalHold of a blob container.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar tag: The tag value.
:vartype tag: str
:ivar timestamp: Returns the date and time the tag was added.
:vartype timestamp: datetime
:ivar object_identifier: Returns the Object ID of the user who added the
tag.
:vartype object_identifier: str
:ivar tenant_id: Returns the Tenant ID that issued the token for the user
who added the tag.
:vartype tenant_id: str
:ivar upn: Returns the User Principal Name of the user who added the tag.
:vartype upn: str
"""
_validation = {
'tag': {'readonly': True},
'timestamp': {'readonly': True},
'object_identifier': {'readonly': True},
'tenant_id': {'readonly': True},
'upn': {'readonly': True},
}
_attribute_map = {
'tag': {'key': 'tag', 'type': 'str'},
'timestamp': {'key': 'timestamp', 'type': 'iso-8601'},
'object_identifier': {'key': 'objectIdentifier', 'type': 'str'},
'tenant_id': {'key': 'tenantId', 'type': 'str'},
'upn': {'key': 'upn', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(TagProperty, self).__init__(**kwargs)
self.tag = None
self.timestamp = None
self.object_identifier = None
self.tenant_id = None
self.upn = None
[docs]class UpdateHistoryProperty(Model):
"""An update history of the ImmutabilityPolicy of a blob container.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar update: The ImmutabilityPolicy update type of a blob container,
possible values include: put, lock and extend. Possible values include:
'put', 'lock', 'extend'
:vartype update: str or
~azure.mgmt.storage.v2018_02_01.models.ImmutabilityPolicyUpdateType
:ivar immutability_period_since_creation_in_days: The immutability period
for the blobs in the container since the policy creation, in days.
:vartype immutability_period_since_creation_in_days: int
:ivar timestamp: Returns the date and time the ImmutabilityPolicy was
updated.
:vartype timestamp: datetime
:ivar object_identifier: Returns the Object ID of the user who updated the
ImmutabilityPolicy.
:vartype object_identifier: str
:ivar tenant_id: Returns the Tenant ID that issued the token for the user
who updated the ImmutabilityPolicy.
:vartype tenant_id: str
:ivar upn: Returns the User Principal Name of the user who updated the
ImmutabilityPolicy.
:vartype upn: str
"""
_validation = {
'update': {'readonly': True},
'immutability_period_since_creation_in_days': {'readonly': True},
'timestamp': {'readonly': True},
'object_identifier': {'readonly': True},
'tenant_id': {'readonly': True},
'upn': {'readonly': True},
}
_attribute_map = {
'update': {'key': 'update', 'type': 'str'},
'immutability_period_since_creation_in_days': {'key': 'immutabilityPeriodSinceCreationInDays', 'type': 'int'},
'timestamp': {'key': 'timestamp', 'type': 'iso-8601'},
'object_identifier': {'key': 'objectIdentifier', 'type': 'str'},
'tenant_id': {'key': 'tenantId', 'type': 'str'},
'upn': {'key': 'upn', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(UpdateHistoryProperty, self).__init__(**kwargs)
self.update = None
self.immutability_period_since_creation_in_days = None
self.timestamp = None
self.object_identifier = None
self.tenant_id = None
self.upn = None
[docs]class Usage(Model):
"""Describes Storage Resource Usage.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar unit: Gets the unit of measurement. Possible values include:
'Count', 'Bytes', 'Seconds', 'Percent', 'CountsPerSecond',
'BytesPerSecond'
:vartype unit: str or ~azure.mgmt.storage.v2018_02_01.models.UsageUnit
:ivar current_value: Gets the current count of the allocated resources in
the subscription.
:vartype current_value: int
:ivar limit: Gets the maximum count of the resources that can be allocated
in the subscription.
:vartype limit: int
:ivar name: Gets the name of the type of usage.
:vartype name: ~azure.mgmt.storage.v2018_02_01.models.UsageName
"""
_validation = {
'unit': {'readonly': True},
'current_value': {'readonly': True},
'limit': {'readonly': True},
'name': {'readonly': True},
}
_attribute_map = {
'unit': {'key': 'unit', 'type': 'UsageUnit'},
'current_value': {'key': 'currentValue', 'type': 'int'},
'limit': {'key': 'limit', 'type': 'int'},
'name': {'key': 'name', 'type': 'UsageName'},
}
def __init__(self, **kwargs) -> None:
super(Usage, self).__init__(**kwargs)
self.unit = None
self.current_value = None
self.limit = None
self.name = None
[docs]class UsageName(Model):
"""The usage names that can be used; currently limited to StorageAccount.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar value: Gets a string describing the resource name.
:vartype value: str
:ivar localized_value: Gets a localized string describing the resource
name.
:vartype localized_value: str
"""
_validation = {
'value': {'readonly': True},
'localized_value': {'readonly': True},
}
_attribute_map = {
'value': {'key': 'value', 'type': 'str'},
'localized_value': {'key': 'localizedValue', 'type': 'str'},
}
def __init__(self, **kwargs) -> None:
super(UsageName, self).__init__(**kwargs)
self.value = None
self.localized_value = None
[docs]class VirtualNetworkRule(Model):
"""Virtual Network rule.
All required parameters must be populated in order to send to Azure.
:param virtual_network_resource_id: Required. Resource ID of a subnet, for
example:
/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}.
:type virtual_network_resource_id: str
:param action: The action of virtual network rule. Possible values
include: 'Allow'. Default value: "Allow" .
:type action: str or ~azure.mgmt.storage.v2018_02_01.models.Action
:param state: Gets the state of virtual network rule. Possible values
include: 'provisioning', 'deprovisioning', 'succeeded', 'failed',
'networkSourceDeleted'
:type state: str or ~azure.mgmt.storage.v2018_02_01.models.State
"""
_validation = {
'virtual_network_resource_id': {'required': True},
}
_attribute_map = {
'virtual_network_resource_id': {'key': 'id', 'type': 'str'},
'action': {'key': 'action', 'type': 'Action'},
'state': {'key': 'state', 'type': 'State'},
}
def __init__(self, *, virtual_network_resource_id: str, action="Allow", state=None, **kwargs) -> None:
super(VirtualNetworkRule, self).__init__(**kwargs)
self.virtual_network_resource_id = virtual_network_resource_id
self.action = action
self.state = state