# 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 CheckNameAvailabilityResult(Model):
"""The CheckNameAvailability operation response.
:param name_available: 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.
:type name_available: bool
:param reason: 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'
:type reason: str or ~azure.mgmt.storage.v2015_06_15.models.Reason
:param message: The error message explaining the Reason value in more
detail.
:type message: str
"""
_attribute_map = {
'name_available': {'key': 'nameAvailable', 'type': 'bool'},
'reason': {'key': 'reason', 'type': 'Reason'},
'message': {'key': 'message', 'type': 'str'},
}
def __init__(self, *, name_available: bool=None, reason=None, message: str=None, **kwargs) -> None:
super(CheckNameAvailabilityResult, self).__init__(**kwargs)
self.name_available = name_available
self.reason = reason
self.message = message
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. The custom domain name. 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 Endpoints(Model):
"""The URIs that are used to perform a retrieval of a public blob, queue or
table object.
:param blob: The blob endpoint.
:type blob: str
:param queue: The queue endpoint.
:type queue: str
:param table: The table endpoint.
:type table: str
:param file: The file endpoint.
:type file: str
"""
_attribute_map = {
'blob': {'key': 'blob', 'type': 'str'},
'queue': {'key': 'queue', 'type': 'str'},
'table': {'key': 'table', 'type': 'str'},
'file': {'key': 'file', 'type': 'str'},
}
def __init__(self, *, blob: str=None, queue: str=None, table: str=None, file: str=None, **kwargs) -> None:
super(Endpoints, self).__init__(**kwargs)
self.blob = blob
self.queue = queue
self.table = table
self.file = file
[docs]class Resource(Model):
"""Describes a storage resource.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar id: Resource Id
:vartype id: str
:ivar name: Resource name
:vartype name: str
:ivar type: Resource type
:vartype type: str
:param location: Resource location
:type location: str
:param tags: Resource tags
:type tags: dict[str, 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'},
'location': {'key': 'location', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
}
def __init__(self, *, location: str=None, tags=None, **kwargs) -> None:
super(Resource, self).__init__(**kwargs)
self.id = None
self.name = None
self.type = None
self.location = location
self.tags = tags
[docs]class StorageAccount(Resource):
"""The storage account.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar id: Resource Id
:vartype id: str
:ivar name: Resource name
:vartype name: str
:ivar type: Resource type
:vartype type: str
:param location: Resource location
:type location: str
:param tags: Resource tags
:type tags: dict[str, str]
:param provisioning_state: The status of the storage account at the time
the operation was called. Possible values include: 'Creating',
'ResolvingDNS', 'Succeeded'
:type provisioning_state: str or
~azure.mgmt.storage.v2015_06_15.models.ProvisioningState
:param account_type: The type of the storage account. Possible values
include: 'Standard_LRS', 'Standard_ZRS', 'Standard_GRS', 'Standard_RAGRS',
'Premium_LRS'
:type account_type: str or
~azure.mgmt.storage.v2015_06_15.models.AccountType
:param primary_endpoints: 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.
:type primary_endpoints: ~azure.mgmt.storage.v2015_06_15.models.Endpoints
:param primary_location: The location of the primary data center for the
storage account.
:type primary_location: str
:param status_of_primary: The status indicating whether the primary
location of the storage account is available or unavailable. Possible
values include: 'Available', 'Unavailable'
:type status_of_primary: str or
~azure.mgmt.storage.v2015_06_15.models.AccountStatus
:param last_geo_failover_time: 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.
:type last_geo_failover_time: datetime
:param secondary_location: The location of the geo-replicated secondary
for the storage account. Only available if the accountType is Standard_GRS
or Standard_RAGRS.
:type secondary_location: str
:param status_of_secondary: 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'
:type status_of_secondary: str or
~azure.mgmt.storage.v2015_06_15.models.AccountStatus
:param creation_time: The creation date and time of the storage account in
UTC.
:type creation_time: datetime
:param custom_domain: The custom domain the user assigned to this storage
account.
:type custom_domain: ~azure.mgmt.storage.v2015_06_15.models.CustomDomain
:param secondary_endpoints: 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.
:type secondary_endpoints:
~azure.mgmt.storage.v2015_06_15.models.Endpoints
"""
_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'},
'location': {'key': 'location', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'ProvisioningState'},
'account_type': {'key': 'properties.accountType', 'type': 'AccountType'},
'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'},
}
def __init__(self, *, location: str=None, tags=None, provisioning_state=None, account_type=None, primary_endpoints=None, primary_location: str=None, status_of_primary=None, last_geo_failover_time=None, secondary_location: str=None, status_of_secondary=None, creation_time=None, custom_domain=None, secondary_endpoints=None, **kwargs) -> None:
super(StorageAccount, self).__init__(location=location, tags=tags, **kwargs)
self.provisioning_state = provisioning_state
self.account_type = account_type
self.primary_endpoints = primary_endpoints
self.primary_location = primary_location
self.status_of_primary = status_of_primary
self.last_geo_failover_time = last_geo_failover_time
self.secondary_location = secondary_location
self.status_of_secondary = status_of_secondary
self.creation_time = creation_time
self.custom_domain = custom_domain
self.secondary_endpoints = secondary_endpoints
[docs]class StorageAccountCheckNameAvailabilityParameters(Model):
"""The parameters used to check the availability of the storage account name.
All required parameters must be populated in order to send to Azure.
:param name: Required.
:type name: str
:param type: Default value: "Microsoft.Storage/storageAccounts" .
:type type: str
"""
_validation = {
'name': {'required': True},
}
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
}
def __init__(self, *, name: str, type: str="Microsoft.Storage/storageAccounts", **kwargs) -> None:
super(StorageAccountCheckNameAvailabilityParameters, self).__init__(**kwargs)
self.name = name
self.type = type
[docs]class StorageAccountCreateParameters(Model):
"""The parameters to provide for the account.
All required parameters must be populated in order to send to Azure.
:param location: Required. 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: 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 account_type: Required. 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_ZRS', 'Standard_GRS', 'Standard_RAGRS', 'Premium_LRS'
:type account_type: str or
~azure.mgmt.storage.v2015_06_15.models.AccountType
"""
_validation = {
'location': {'required': True},
'account_type': {'required': True},
}
_attribute_map = {
'location': {'key': 'location', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'account_type': {'key': 'properties.accountType', 'type': 'AccountType'},
}
def __init__(self, *, location: str, account_type, tags=None, **kwargs) -> None:
super(StorageAccountCreateParameters, self).__init__(**kwargs)
self.location = location
self.tags = tags
self.account_type = account_type
[docs]class StorageAccountKeys(Model):
"""The access keys for the storage account.
:param key1: The value of key 1.
:type key1: str
:param key2: The value of key 2.
:type key2: str
"""
_attribute_map = {
'key1': {'key': 'key1', 'type': 'str'},
'key2': {'key': 'key2', 'type': 'str'},
}
def __init__(self, *, key1: str=None, key2: str=None, **kwargs) -> None:
super(StorageAccountKeys, self).__init__(**kwargs)
self.key1 = key1
self.key2 = key2
[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.
: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 to update on the account.
:param tags: Resource tags
:type tags: dict[str, str]
:param account_type: The account type. Note that StandardZRS and
PremiumLRS accounts cannot be changed to other account types, and other
account types cannot be changed to StandardZRS or PremiumLRS. Possible
values include: 'Standard_LRS', 'Standard_ZRS', 'Standard_GRS',
'Standard_RAGRS', 'Premium_LRS'
:type account_type: str or
~azure.mgmt.storage.v2015_06_15.models.AccountType
: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.v2015_06_15.models.CustomDomain
"""
_attribute_map = {
'tags': {'key': 'tags', 'type': '{str}'},
'account_type': {'key': 'properties.accountType', 'type': 'AccountType'},
'custom_domain': {'key': 'properties.customDomain', 'type': 'CustomDomain'},
}
def __init__(self, *, tags=None, account_type=None, custom_domain=None, **kwargs) -> None:
super(StorageAccountUpdateParameters, self).__init__(**kwargs)
self.tags = tags
self.account_type = account_type
self.custom_domain = custom_domain
[docs]class Usage(Model):
"""Describes Storage Resource Usage.
All required parameters must be populated in order to send to Azure.
:param unit: Required. The unit of measurement. Possible values include:
'Count', 'Bytes', 'Seconds', 'Percent', 'CountsPerSecond',
'BytesPerSecond'
:type unit: str or ~azure.mgmt.storage.v2015_06_15.models.UsageUnit
:param current_value: Required. The current count of the allocated
resources in the subscription.
:type current_value: int
:param limit: Required. The maximum count of the resources that can be
allocated in the subscription.
:type limit: int
:param name: Required. The name of the type of usage.
:type name: ~azure.mgmt.storage.v2015_06_15.models.UsageName
"""
_validation = {
'unit': {'required': True},
'current_value': {'required': True},
'limit': {'required': True},
'name': {'required': 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, *, unit, current_value: int, limit: int, name, **kwargs) -> None:
super(Usage, self).__init__(**kwargs)
self.unit = unit
self.current_value = current_value
self.limit = limit
self.name = name
[docs]class UsageName(Model):
"""The Usage Names.
:param value: A string describing the resource name.
:type value: str
:param localized_value: A localized string describing the resource name.
:type localized_value: str
"""
_attribute_map = {
'value': {'key': 'value', 'type': 'str'},
'localized_value': {'key': 'localizedValue', 'type': 'str'},
}
def __init__(self, *, value: str=None, localized_value: str=None, **kwargs) -> None:
super(UsageName, self).__init__(**kwargs)
self.value = value
self.localized_value = localized_value