1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
# 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 .resource import Resource
class DatabaseAccount(Resource):
"""A DocumentDB database account.
Variables are only populated by the server, and will be ignored when
sending a request.
:ivar id: The unique resource identifier of the database account.
:vartype id: str
:ivar name: The name of the database account.
:vartype name: str
:ivar type: The type of Azure resource.
:vartype type: str
:param location: The location of the resource group to which the resource
belongs.
:type location: str
:param tags:
:type tags: dict
:param kind: Indicates the type of database account. This can only be set
at database account creation. Possible values include: 'GlobalDocumentDB',
'MongoDB', 'Parse'. Default value: "GlobalDocumentDB" .
:type kind: str or :class:`DatabaseAccountKind
<azure.mgmt.documentdb.models.DatabaseAccountKind>`
:param provisioning_state:
:type provisioning_state: str
:ivar document_endpoint: The connection endpoint for the DocumentDB
database account.
:vartype document_endpoint: str
:ivar database_account_offer_type: The offer type for the DocumentDB
database account. Default value: Standard. Possible values include:
'Standard'
:vartype database_account_offer_type: str or
:class:`DatabaseAccountOfferType
<azure.mgmt.documentdb.models.DatabaseAccountOfferType>`
:param ip_range_filter: DocumentDB Firewall Support: This value specifies
the set of IP addresses or IP address ranges in CIDR form to be included
as the allowed list of client IPs for a given database account. IP
addresses/ranges must be comma separated and must not contain any spaces.
:type ip_range_filter: str
:param enable_automatic_failover: Enables automatic failover of the write
region in the rare event that the region is unavailable due to an outage.
Automatic failover will result in a new write region for the account and
is chosen based on the failover priorities configured for the account.
:type enable_automatic_failover: bool
:param consistency_policy: The consistency policy for the DocumentDB
database account.
:type consistency_policy: :class:`ConsistencyPolicy
<azure.mgmt.documentdb.models.ConsistencyPolicy>`
:ivar write_locations: An array that contains the write location for the
DocumentDB account.
:vartype write_locations: list of :class:`Location
<azure.mgmt.documentdb.models.Location>`
:ivar read_locations: An array that contains of the read locations enabled
for the DocumentDB account.
:vartype read_locations: list of :class:`Location
<azure.mgmt.documentdb.models.Location>`
:ivar failover_policies: An array that contains the regions ordered by
their failover priorities.
:vartype failover_policies: list of :class:`FailoverPolicy
<azure.mgmt.documentdb.models.FailoverPolicy>`
"""
_validation = {
'id': {'readonly': True},
'name': {'readonly': True},
'type': {'readonly': True},
'location': {'required': True},
'document_endpoint': {'readonly': True},
'database_account_offer_type': {'readonly': True},
'write_locations': {'readonly': True},
'read_locations': {'readonly': True},
'failover_policies': {'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}'},
'kind': {'key': 'kind', 'type': 'str'},
'provisioning_state': {'key': 'properties.provisioningState', 'type': 'str'},
'document_endpoint': {'key': 'properties.documentEndpoint', 'type': 'str'},
'database_account_offer_type': {'key': 'properties.databaseAccountOfferType', 'type': 'DatabaseAccountOfferType'},
'ip_range_filter': {'key': 'properties.ipRangeFilter', 'type': 'str'},
'enable_automatic_failover': {'key': 'properties.enableAutomaticFailover', 'type': 'bool'},
'consistency_policy': {'key': 'properties.consistencyPolicy', 'type': 'ConsistencyPolicy'},
'write_locations': {'key': 'properties.writeLocations', 'type': '[Location]'},
'read_locations': {'key': 'properties.readLocations', 'type': '[Location]'},
'failover_policies': {'key': 'properties.failoverPolicies', 'type': '[FailoverPolicy]'},
}
def __init__(self, location, tags=None, kind="GlobalDocumentDB", provisioning_state=None, ip_range_filter=None, enable_automatic_failover=None, consistency_policy=None):
super(DatabaseAccount, self).__init__(location=location, tags=tags)
self.kind = kind
self.provisioning_state = provisioning_state
self.document_endpoint = None
self.database_account_offer_type = None
self.ip_range_filter = ip_range_filter
self.enable_automatic_failover = enable_automatic_failover
self.consistency_policy = consistency_policy
self.write_locations = None
self.read_locations = None
self.failover_policies = None
|
