# 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.
# --------------------------------------------------------------------------
import datetime
from typing import Dict, List, Optional, Union
import msrest.serialization
from ._storage_management_enums import *
[docs]class CheckNameAvailabilityResult(msrest.serialization.Model):
"""The CheckNameAvailability operation response.
:ivar 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.
:vartype name_available: bool
:ivar 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".
:vartype reason: str or ~azure.mgmt.storage.v2015_06_15.models.Reason
:ivar message: The error message explaining the Reason value in more detail.
:vartype message: str
"""
_attribute_map = {
'name_available': {'key': 'nameAvailable', 'type': 'bool'},
'reason': {'key': 'reason', 'type': 'str'},
'message': {'key': 'message', 'type': 'str'},
}
def __init__(
self,
*,
name_available: Optional[bool] = None,
reason: Optional[Union[str, "Reason"]] = None,
message: Optional[str] = None,
**kwargs
):
"""
:keyword 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.
:paramtype name_available: bool
:keyword 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".
:paramtype reason: str or ~azure.mgmt.storage.v2015_06_15.models.Reason
:keyword message: The error message explaining the Reason value in more detail.
:paramtype message: str
"""
super(CheckNameAvailabilityResult, self).__init__(**kwargs)
self.name_available = name_available
self.reason = reason
self.message = message
[docs]class CustomDomain(msrest.serialization.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.
:ivar name: Required. The custom domain name. Name is the CNAME source.
:vartype name: str
:ivar use_sub_domain_name: Indicates whether indirect CName validation is enabled. Default
value is false. This should only be set on updates.
:vartype 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: Optional[bool] = None,
**kwargs
):
"""
:keyword name: Required. The custom domain name. Name is the CNAME source.
:paramtype name: str
:keyword use_sub_domain_name: Indicates whether indirect CName validation is enabled. Default
value is false. This should only be set on updates.
:paramtype use_sub_domain_name: bool
"""
super(CustomDomain, self).__init__(**kwargs)
self.name = name
self.use_sub_domain_name = use_sub_domain_name
[docs]class Endpoints(msrest.serialization.Model):
"""The URIs that are used to perform a retrieval of a public blob, queue or table object.
:ivar blob: The blob endpoint.
:vartype blob: str
:ivar queue: The queue endpoint.
:vartype queue: str
:ivar table: The table endpoint.
:vartype table: str
:ivar file: The file endpoint.
:vartype 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: Optional[str] = None,
queue: Optional[str] = None,
table: Optional[str] = None,
file: Optional[str] = None,
**kwargs
):
"""
:keyword blob: The blob endpoint.
:paramtype blob: str
:keyword queue: The queue endpoint.
:paramtype queue: str
:keyword table: The table endpoint.
:paramtype table: str
:keyword file: The file endpoint.
:paramtype file: str
"""
super(Endpoints, self).__init__(**kwargs)
self.blob = blob
self.queue = queue
self.table = table
self.file = file
[docs]class Resource(msrest.serialization.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
:ivar location: Resource location.
:vartype location: str
:ivar tags: A set of tags. Resource tags.
:vartype 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: Optional[str] = None,
tags: Optional[Dict[str, str]] = None,
**kwargs
):
"""
:keyword location: Resource location.
:paramtype location: str
:keyword tags: A set of tags. Resource tags.
:paramtype tags: dict[str, str]
"""
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
:ivar location: Resource location.
:vartype location: str
:ivar tags: A set of tags. Resource tags.
:vartype tags: dict[str, str]
:ivar provisioning_state: 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.v2015_06_15.models.ProvisioningState
:ivar account_type: The type of the storage account. Possible values include: "Standard_LRS",
"Standard_ZRS", "Standard_GRS", "Standard_RAGRS", "Premium_LRS".
:vartype account_type: str or ~azure.mgmt.storage.v2015_06_15.models.AccountType
:ivar 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.
:vartype primary_endpoints: ~azure.mgmt.storage.v2015_06_15.models.Endpoints
:ivar primary_location: The location of the primary data center for the storage account.
:vartype primary_location: str
:ivar status_of_primary: 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.v2015_06_15.models.AccountStatus
:ivar 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.
:vartype last_geo_failover_time: ~datetime.datetime
:ivar secondary_location: 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: 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.v2015_06_15.models.AccountStatus
:ivar creation_time: The creation date and time of the storage account in UTC.
:vartype creation_time: ~datetime.datetime
:ivar custom_domain: The custom domain the user assigned to this storage account.
:vartype custom_domain: ~azure.mgmt.storage.v2015_06_15.models.CustomDomain
:ivar 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.
:vartype 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': 'str'},
'account_type': {'key': 'properties.accountType', 'type': 'str'},
'primary_endpoints': {'key': 'properties.primaryEndpoints', 'type': 'Endpoints'},
'primary_location': {'key': 'properties.primaryLocation', 'type': 'str'},
'status_of_primary': {'key': 'properties.statusOfPrimary', 'type': 'str'},
'last_geo_failover_time': {'key': 'properties.lastGeoFailoverTime', 'type': 'iso-8601'},
'secondary_location': {'key': 'properties.secondaryLocation', 'type': 'str'},
'status_of_secondary': {'key': 'properties.statusOfSecondary', 'type': 'str'},
'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: Optional[str] = None,
tags: Optional[Dict[str, str]] = None,
provisioning_state: Optional[Union[str, "ProvisioningState"]] = None,
account_type: Optional[Union[str, "AccountType"]] = None,
primary_endpoints: Optional["Endpoints"] = None,
primary_location: Optional[str] = None,
status_of_primary: Optional[Union[str, "AccountStatus"]] = None,
last_geo_failover_time: Optional[datetime.datetime] = None,
secondary_location: Optional[str] = None,
status_of_secondary: Optional[Union[str, "AccountStatus"]] = None,
creation_time: Optional[datetime.datetime] = None,
custom_domain: Optional["CustomDomain"] = None,
secondary_endpoints: Optional["Endpoints"] = None,
**kwargs
):
"""
:keyword location: Resource location.
:paramtype location: str
:keyword tags: A set of tags. Resource tags.
:paramtype tags: dict[str, str]
:keyword provisioning_state: The status of the storage account at the time the operation was
called. Possible values include: "Creating", "ResolvingDNS", "Succeeded".
:paramtype provisioning_state: str or ~azure.mgmt.storage.v2015_06_15.models.ProvisioningState
:keyword account_type: The type of the storage account. Possible values include:
"Standard_LRS", "Standard_ZRS", "Standard_GRS", "Standard_RAGRS", "Premium_LRS".
:paramtype account_type: str or ~azure.mgmt.storage.v2015_06_15.models.AccountType
:keyword 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.
:paramtype primary_endpoints: ~azure.mgmt.storage.v2015_06_15.models.Endpoints
:keyword primary_location: The location of the primary data center for the storage account.
:paramtype primary_location: str
:keyword status_of_primary: The status indicating whether the primary location of the storage
account is available or unavailable. Possible values include: "Available", "Unavailable".
:paramtype status_of_primary: str or ~azure.mgmt.storage.v2015_06_15.models.AccountStatus
:keyword 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.
:paramtype last_geo_failover_time: ~datetime.datetime
:keyword secondary_location: The location of the geo-replicated secondary for the storage
account. Only available if the accountType is Standard_GRS or Standard_RAGRS.
:paramtype secondary_location: str
:keyword 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".
:paramtype status_of_secondary: str or ~azure.mgmt.storage.v2015_06_15.models.AccountStatus
:keyword creation_time: The creation date and time of the storage account in UTC.
:paramtype creation_time: ~datetime.datetime
:keyword custom_domain: The custom domain the user assigned to this storage account.
:paramtype custom_domain: ~azure.mgmt.storage.v2015_06_15.models.CustomDomain
:keyword 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.
:paramtype secondary_endpoints: ~azure.mgmt.storage.v2015_06_15.models.Endpoints
"""
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(msrest.serialization.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.
:ivar name: Required.
:vartype name: str
:ivar type:
:vartype type: str
"""
_validation = {
'name': {'required': True},
}
_attribute_map = {
'name': {'key': 'name', 'type': 'str'},
'type': {'key': 'type', 'type': 'str'},
}
def __init__(
self,
*,
name: str,
type: Optional[str] = "Microsoft.Storage/storageAccounts",
**kwargs
):
"""
:keyword name: Required.
:paramtype name: str
:keyword type:
:paramtype type: str
"""
super(StorageAccountCheckNameAvailabilityParameters, self).__init__(**kwargs)
self.name = name
self.type = type
[docs]class StorageAccountCreateParameters(msrest.serialization.Model):
"""The parameters to provide for the account.
All required parameters must be populated in order to send to Azure.
:ivar 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.
:vartype location: str
:ivar tags: A set of 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.
:vartype tags: dict[str, str]
:ivar account_type: 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".
:vartype account_type: str or ~azure.mgmt.storage.v2015_06_15.models.AccountType
"""
_validation = {
'location': {'required': True},
}
_attribute_map = {
'location': {'key': 'location', 'type': 'str'},
'tags': {'key': 'tags', 'type': '{str}'},
'account_type': {'key': 'properties.accountType', 'type': 'str'},
}
def __init__(
self,
*,
location: str,
tags: Optional[Dict[str, str]] = None,
account_type: Optional[Union[str, "AccountType"]] = None,
**kwargs
):
"""
:keyword 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.
:paramtype location: str
:keyword tags: A set of 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.
:paramtype tags: dict[str, str]
:keyword account_type: 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".
:paramtype account_type: str or ~azure.mgmt.storage.v2015_06_15.models.AccountType
"""
super(StorageAccountCreateParameters, self).__init__(**kwargs)
self.location = location
self.tags = tags
self.account_type = account_type
[docs]class StorageAccountKeys(msrest.serialization.Model):
"""The access keys for the storage account.
:ivar key1: The value of key 1.
:vartype key1: str
:ivar key2: The value of key 2.
:vartype key2: str
"""
_attribute_map = {
'key1': {'key': 'key1', 'type': 'str'},
'key2': {'key': 'key2', 'type': 'str'},
}
def __init__(
self,
*,
key1: Optional[str] = None,
key2: Optional[str] = None,
**kwargs
):
"""
:keyword key1: The value of key 1.
:paramtype key1: str
:keyword key2: The value of key 2.
:paramtype key2: str
"""
super(StorageAccountKeys, self).__init__(**kwargs)
self.key1 = key1
self.key2 = key2
[docs]class StorageAccountListResult(msrest.serialization.Model):
"""The list storage accounts operation response.
:ivar value: The list of storage accounts and their properties.
:vartype value: list[~azure.mgmt.storage.v2015_06_15.models.StorageAccount]
"""
_attribute_map = {
'value': {'key': 'value', 'type': '[StorageAccount]'},
}
def __init__(
self,
*,
value: Optional[List["StorageAccount"]] = None,
**kwargs
):
"""
:keyword value: The list of storage accounts and their properties.
:paramtype value: list[~azure.mgmt.storage.v2015_06_15.models.StorageAccount]
"""
super(StorageAccountListResult, self).__init__(**kwargs)
self.value = value
[docs]class StorageAccountRegenerateKeyParameters(msrest.serialization.Model):
"""The parameters used to regenerate the storage account key.
All required parameters must be populated in order to send to Azure.
:ivar key_name: Required.
:vartype key_name: str
"""
_validation = {
'key_name': {'required': True},
}
_attribute_map = {
'key_name': {'key': 'keyName', 'type': 'str'},
}
def __init__(
self,
*,
key_name: str,
**kwargs
):
"""
:keyword key_name: Required.
:paramtype key_name: str
"""
super(StorageAccountRegenerateKeyParameters, self).__init__(**kwargs)
self.key_name = key_name
[docs]class StorageAccountUpdateParameters(msrest.serialization.Model):
"""The parameters to update on the account.
:ivar tags: A set of tags. Resource tags.
:vartype tags: dict[str, str]
:ivar 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".
:vartype account_type: str or ~azure.mgmt.storage.v2015_06_15.models.AccountType
:ivar 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.
:vartype custom_domain: ~azure.mgmt.storage.v2015_06_15.models.CustomDomain
"""
_attribute_map = {
'tags': {'key': 'tags', 'type': '{str}'},
'account_type': {'key': 'properties.accountType', 'type': 'str'},
'custom_domain': {'key': 'properties.customDomain', 'type': 'CustomDomain'},
}
def __init__(
self,
*,
tags: Optional[Dict[str, str]] = None,
account_type: Optional[Union[str, "AccountType"]] = None,
custom_domain: Optional["CustomDomain"] = None,
**kwargs
):
"""
:keyword tags: A set of tags. Resource tags.
:paramtype tags: dict[str, str]
:keyword 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".
:paramtype account_type: str or ~azure.mgmt.storage.v2015_06_15.models.AccountType
:keyword 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.
:paramtype custom_domain: ~azure.mgmt.storage.v2015_06_15.models.CustomDomain
"""
super(StorageAccountUpdateParameters, self).__init__(**kwargs)
self.tags = tags
self.account_type = account_type
self.custom_domain = custom_domain
[docs]class Usage(msrest.serialization.Model):
"""Describes Storage Resource Usage.
All required parameters must be populated in order to send to Azure.
:ivar unit: Required. The unit of measurement. Possible values include: "Count", "Bytes",
"Seconds", "Percent", "CountsPerSecond", "BytesPerSecond".
:vartype unit: str or ~azure.mgmt.storage.v2015_06_15.models.UsageUnit
:ivar current_value: Required. The current count of the allocated resources in the
subscription.
:vartype current_value: int
:ivar limit: Required. The maximum count of the resources that can be allocated in the
subscription.
:vartype limit: int
:ivar name: Required. The name of the type of usage.
:vartype 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': 'str'},
'current_value': {'key': 'currentValue', 'type': 'int'},
'limit': {'key': 'limit', 'type': 'int'},
'name': {'key': 'name', 'type': 'UsageName'},
}
def __init__(
self,
*,
unit: Union[str, "UsageUnit"],
current_value: int,
limit: int,
name: "UsageName",
**kwargs
):
"""
:keyword unit: Required. The unit of measurement. Possible values include: "Count", "Bytes",
"Seconds", "Percent", "CountsPerSecond", "BytesPerSecond".
:paramtype unit: str or ~azure.mgmt.storage.v2015_06_15.models.UsageUnit
:keyword current_value: Required. The current count of the allocated resources in the
subscription.
:paramtype current_value: int
:keyword limit: Required. The maximum count of the resources that can be allocated in the
subscription.
:paramtype limit: int
:keyword name: Required. The name of the type of usage.
:paramtype name: ~azure.mgmt.storage.v2015_06_15.models.UsageName
"""
super(Usage, self).__init__(**kwargs)
self.unit = unit
self.current_value = current_value
self.limit = limit
self.name = name
[docs]class UsageListResult(msrest.serialization.Model):
"""The List Usages operation response.
:ivar value: The list Storage Resource Usages.
:vartype value: list[~azure.mgmt.storage.v2015_06_15.models.Usage]
"""
_attribute_map = {
'value': {'key': 'value', 'type': '[Usage]'},
}
def __init__(
self,
*,
value: Optional[List["Usage"]] = None,
**kwargs
):
"""
:keyword value: The list Storage Resource Usages.
:paramtype value: list[~azure.mgmt.storage.v2015_06_15.models.Usage]
"""
super(UsageListResult, self).__init__(**kwargs)
self.value = value
[docs]class UsageName(msrest.serialization.Model):
"""The Usage Names.
:ivar value: A string describing the resource name.
:vartype value: str
:ivar localized_value: A localized string describing the resource name.
:vartype localized_value: str
"""
_attribute_map = {
'value': {'key': 'value', 'type': 'str'},
'localized_value': {'key': 'localizedValue', 'type': 'str'},
}
def __init__(
self,
*,
value: Optional[str] = None,
localized_value: Optional[str] = None,
**kwargs
):
"""
:keyword value: A string describing the resource name.
:paramtype value: str
:keyword localized_value: A localized string describing the resource name.
:paramtype localized_value: str
"""
super(UsageName, self).__init__(**kwargs)
self.value = value
self.localized_value = localized_value