mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Adding cosmosdb account facts module (#51993)
This commit is contained in:
Zim Kalinowski
Yunge Zhu
parent
d6600b0ab6
commit
103b4c1d09
3 changed files with 612 additions and 0 deletions
|
|
@ -0,0 +1,513 @@
|
|||
#!/usr/bin/python
|
||||
#
|
||||
# Copyright (c) 2019 Zim Kalinowski, (@zikalino)
|
||||
#
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: azure_rm_cosmosdbaccount_facts
|
||||
version_added: "2.8"
|
||||
short_description: Get Azure Cosmos DB Account facts.
|
||||
description:
|
||||
- Get facts of Azure Cosmos DB Account.
|
||||
|
||||
options:
|
||||
resource_group:
|
||||
description:
|
||||
- Name of an Azure resource group.
|
||||
name:
|
||||
description:
|
||||
- Cosmos DB database account name.
|
||||
tags:
|
||||
description:
|
||||
- Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
|
||||
retrieve_keys:
|
||||
description:
|
||||
- Retrieve keys and connection strings.
|
||||
type: str
|
||||
choices:
|
||||
- all
|
||||
- readonly
|
||||
retrieve_connection_strings:
|
||||
description:
|
||||
- Retrieve connection strings.
|
||||
type: bool
|
||||
|
||||
extends_documentation_fragment:
|
||||
- azure
|
||||
|
||||
author:
|
||||
- "Zim Kalinowski (@zikalino)"
|
||||
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Get instance of Database Account
|
||||
azure_rm_cosmosdbaccount_facts:
|
||||
resource_group: testrg
|
||||
name: testaccount
|
||||
|
||||
- name: List instances of Database Account
|
||||
azure_rm_cosmosdbaccousnt_facts:
|
||||
resource_group: testrg
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
accounts:
|
||||
description: A list of dictionaries containing facts for Database Account.
|
||||
returned: always
|
||||
type: complex
|
||||
contains:
|
||||
id:
|
||||
description:
|
||||
- The unique resource identifier of the database account.
|
||||
returned: always
|
||||
type: str
|
||||
sample: /subscriptions/subid/resourceGroups/testrg/providers/Microsoft.DocumentDB/databaseAccounts/testaccount
|
||||
resource_group:
|
||||
description:
|
||||
- Name of an Azure resource group.
|
||||
returned: always
|
||||
type: str
|
||||
sample: testrg
|
||||
name:
|
||||
description:
|
||||
- The name of the database account.
|
||||
returned: always
|
||||
type: str
|
||||
sample: testaccount
|
||||
location:
|
||||
description:
|
||||
- The location of the resource group to which the resource belongs.
|
||||
returned: always
|
||||
type: str
|
||||
sample: westus
|
||||
kind:
|
||||
description:
|
||||
- Indicates the type of database account.
|
||||
returned: always
|
||||
type: str
|
||||
sample: global_document_db
|
||||
consistency_policy:
|
||||
description:
|
||||
- Consistency policy.
|
||||
returned: always
|
||||
type: complex
|
||||
contains:
|
||||
default_consistency_level:
|
||||
description:
|
||||
- Default consistency level.
|
||||
returned: always
|
||||
type: str
|
||||
sample: session
|
||||
max_interval_in_seconds:
|
||||
description:
|
||||
- Maximum interval in seconds.
|
||||
returned: always
|
||||
type: int
|
||||
sample: 5
|
||||
max_staleness_prefix:
|
||||
description:
|
||||
- Maximum staleness prefix.
|
||||
returned: always
|
||||
type: int
|
||||
sample: 100
|
||||
failover_policies:
|
||||
description:
|
||||
- Read locations
|
||||
returned: always
|
||||
type: complex
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- Location name.
|
||||
returned: always
|
||||
type: str
|
||||
sample: eastus
|
||||
failover_priority:
|
||||
description:
|
||||
- Failover priority.
|
||||
returned: always
|
||||
type: int
|
||||
sample: 0
|
||||
id:
|
||||
description:
|
||||
- Read location ID.
|
||||
returned: always
|
||||
type: str
|
||||
sample: testaccount-eastus
|
||||
read_locations:
|
||||
description:
|
||||
- Read locations
|
||||
returned: always
|
||||
type: complex
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- Location name.
|
||||
returned: always
|
||||
type: str
|
||||
sample: eastus
|
||||
failover_priority:
|
||||
description:
|
||||
- Failover priority.
|
||||
returned: always
|
||||
type: int
|
||||
sample: 0
|
||||
id:
|
||||
description:
|
||||
- Read location ID.
|
||||
returned: always
|
||||
type: str
|
||||
sample: testaccount-eastus
|
||||
document_endpoint:
|
||||
description:
|
||||
- Document endpoint.
|
||||
returned: always
|
||||
type: str
|
||||
sample: https://testaccount-eastus.documents.azure.com:443/
|
||||
provisioning_state:
|
||||
description:
|
||||
- Provisioning state.
|
||||
returned: always
|
||||
type: str
|
||||
sample: Succeeded
|
||||
write_locations:
|
||||
description:
|
||||
- Write locations
|
||||
returned: always
|
||||
type: complex
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- Location name.
|
||||
returned: always
|
||||
type: str
|
||||
sample: eastus
|
||||
failover_priority:
|
||||
description:
|
||||
- Failover priority.
|
||||
returned: always
|
||||
type: int
|
||||
sample: 0
|
||||
id:
|
||||
description:
|
||||
- Read location ID.
|
||||
returned: always
|
||||
type: str
|
||||
sample: testaccount-eastus
|
||||
document_endpoint:
|
||||
description:
|
||||
- Document endpoint.
|
||||
returned: always
|
||||
type: str
|
||||
sample: https://testaccount-eastus.documents.azure.com:443/
|
||||
provisioning_state:
|
||||
description:
|
||||
- Provisioning state.
|
||||
returned: always
|
||||
type: str
|
||||
sample: Succeeded
|
||||
database_account_offer_type:
|
||||
description:
|
||||
- Offer type.
|
||||
returned: always
|
||||
type: str
|
||||
sample: Standard
|
||||
ip_range_filter:
|
||||
description:
|
||||
- Enable IP range filter.
|
||||
returned: always
|
||||
type: str
|
||||
sample: 10.10.10.10
|
||||
is_virtual_network_filter_enabled:
|
||||
description:
|
||||
- Enable virtual network filter.
|
||||
returned: always
|
||||
type: bool
|
||||
sample: true
|
||||
enable_automatic_failover:
|
||||
description:
|
||||
- Enable automatic failover.
|
||||
returned: always
|
||||
type: bool
|
||||
sample: true
|
||||
enable_cassandra:
|
||||
description:
|
||||
- Enable Cassandra
|
||||
returned: always
|
||||
type: bool
|
||||
sample: true
|
||||
enable_table:
|
||||
description:
|
||||
- Enable Table.
|
||||
returned: always
|
||||
type: bool
|
||||
sample: true
|
||||
enable_gremlin:
|
||||
description:
|
||||
- Enable Gremlin.
|
||||
returned: always
|
||||
type: bool
|
||||
sample: true
|
||||
virtual_network_rules:
|
||||
description:
|
||||
- List of Virtual Network ACL rules configured for the Cosmos DB account.
|
||||
type: list
|
||||
contains:
|
||||
subnet:
|
||||
description:
|
||||
- Resource id of a subnet.
|
||||
type: str
|
||||
sample: /subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet1
|
||||
ignore_missing_vnet_service_endpoint:
|
||||
description:
|
||||
- Create Cosmos DB account without existing virtual network service endpoint.
|
||||
type: bool
|
||||
enable_multiple_write_locations:
|
||||
description:
|
||||
- Enable multiple write locations.
|
||||
returned: always
|
||||
type: bool
|
||||
sample: true
|
||||
document_endpoint:
|
||||
description:
|
||||
- Document endpoint.
|
||||
returned: always
|
||||
type: str
|
||||
sample: https://testaccount.documents.azure.com:443/
|
||||
provisioning_state:
|
||||
description:
|
||||
- Provisioning state of Cosmos DB.
|
||||
returned: always
|
||||
type: str
|
||||
sample: Succeeded
|
||||
primary_master_key:
|
||||
description:
|
||||
- Primary master key.
|
||||
returned: when requested
|
||||
type: str
|
||||
sample: UIWoYD4YaD4LxW6k3Jy69qcHDMLX4aSttECQkEcwWF1RflLd6crWSGJs0R9kJwujehtfLGeQx4ISVSJfTpJkYw==
|
||||
secondary_master_key:
|
||||
description:
|
||||
- Primary master key.
|
||||
returned: when requested
|
||||
type: str
|
||||
sample: UIWoYD4YaD4LxW6k3Jy69qcHDMLX4aSttECQkEcwWF1RflLd6crWSGJs0R9kJwujehtfLGeQx4ISVSJfTpJkYw==
|
||||
primary_readonly_master_key:
|
||||
description:
|
||||
- Primary master key.
|
||||
returned: when requested
|
||||
type: str
|
||||
sample: UIWoYD4YaD4LxW6k3Jy69qcHDMLX4aSttECQkEcwWF1RflLd6crWSGJs0R9kJwujehtfLGeQx4ISVSJfTpJkYw==
|
||||
secondary_readonly_master_key:
|
||||
description:
|
||||
- Primary master key.
|
||||
returned: when requested
|
||||
type: str
|
||||
sample: UIWoYD4YaD4LxW6k3Jy69qcHDMLX4aSttECQkEcwWF1RflLd6crWSGJs0R9kJwujehtfLGeQx4ISVSJfTpJkYw==
|
||||
connection_strings:
|
||||
description:
|
||||
- List of connection strings.
|
||||
type: list
|
||||
returned: when requested
|
||||
contains:
|
||||
connection_string:
|
||||
description:
|
||||
- Description of connection string.
|
||||
type: str
|
||||
returned: always
|
||||
sample: Primary SQL Connection String
|
||||
description:
|
||||
description:
|
||||
- Connection string.
|
||||
type: str
|
||||
returned: always
|
||||
sample: "AccountEndpoint=https://testaccount.documents.azure.com:443/;AccountKey=fSEjathnk6ZeBTrXkud9j5kfhtSEQ
|
||||
q3dpJxJga76h9BZkK2BJJrDzSO6DDn6yKads017OZBZ1YZWyq1cW4iuvA=="
|
||||
tags:
|
||||
description:
|
||||
- Tags
|
||||
returned: always
|
||||
type: complex
|
||||
sample: {}
|
||||
'''
|
||||
|
||||
from ansible.module_utils.azure_rm_common import AzureRMModuleBase
|
||||
from ansible.module_utils.common.dict_transformations import _camel_to_snake
|
||||
|
||||
try:
|
||||
from msrestazure.azure_exceptions import CloudError
|
||||
from azure.mgmt.cosmosdb import CosmosDB
|
||||
from msrest.serialization import Model
|
||||
except ImportError:
|
||||
# This is handled in azure_rm_common
|
||||
pass
|
||||
|
||||
|
||||
class AzureRMCosmosDBAccountFacts(AzureRMModuleBase):
|
||||
def __init__(self):
|
||||
# define user inputs into argument
|
||||
self.module_arg_spec = dict(
|
||||
resource_group=dict(
|
||||
type='str'
|
||||
),
|
||||
name=dict(
|
||||
type='str'
|
||||
),
|
||||
tags=dict(
|
||||
type='list'
|
||||
),
|
||||
retrieve_keys=dict(
|
||||
type='str',
|
||||
choices=['all', 'readonly']
|
||||
),
|
||||
retrieve_connection_strings=dict(
|
||||
type='bool'
|
||||
)
|
||||
)
|
||||
# store the results of the module operation
|
||||
self.results = dict(
|
||||
changed=False
|
||||
)
|
||||
self.mgmt_client = None
|
||||
self.resource_group = None
|
||||
self.name = None
|
||||
self.tags = None
|
||||
self.retrieve_keys = None
|
||||
self.retrieve_connection_strings = None
|
||||
|
||||
super(AzureRMCosmosDBAccountFacts, self).__init__(self.module_arg_spec, supports_tags=False)
|
||||
|
||||
def exec_module(self, **kwargs):
|
||||
for key in self.module_arg_spec:
|
||||
setattr(self, key, kwargs[key])
|
||||
self.mgmt_client = self.get_mgmt_svc_client(CosmosDB,
|
||||
base_url=self._cloud_environment.endpoints.resource_manager)
|
||||
|
||||
if self.name is not None:
|
||||
self.results['accounts'] = self.get()
|
||||
elif self.resource_group is not None:
|
||||
self.results['accounts'] = self.list_all()
|
||||
return self.results
|
||||
|
||||
def get(self):
|
||||
response = None
|
||||
results = []
|
||||
try:
|
||||
response = self.mgmt_client.database_accounts.get(resource_group_name=self.resource_group,
|
||||
account_name=self.name)
|
||||
self.log("Response : {0}".format(response))
|
||||
except CloudError as e:
|
||||
self.log('Could not get facts for Database Account.')
|
||||
|
||||
if response and self.has_tags(response.tags, self.tags):
|
||||
results.append(self.format_response(response))
|
||||
|
||||
return results
|
||||
|
||||
def list_by_resource_group(self):
|
||||
response = None
|
||||
results = []
|
||||
try:
|
||||
response = self.mgmt_client.database_accounts.list_by_resource_group(resource_group_name=self.resource_group)
|
||||
self.log("Response : {0}".format(response))
|
||||
except CloudError as e:
|
||||
self.log('Could not get facts for Database Account.')
|
||||
|
||||
if response is not None:
|
||||
for item in response:
|
||||
if self.has_tags(item.tags, self.tags):
|
||||
results.append(self.format_response(item))
|
||||
|
||||
return results
|
||||
|
||||
def list_all(self):
|
||||
response = None
|
||||
results = []
|
||||
try:
|
||||
response = self.mgmt_client.database_accounts.list()
|
||||
self.log("Response : {0}".format(response))
|
||||
except CloudError as e:
|
||||
self.log('Could not get facts for Database Account.')
|
||||
|
||||
if response is not None:
|
||||
for item in response:
|
||||
if self.has_tags(item.tags, self.tags):
|
||||
results.append(self.format_response(item))
|
||||
|
||||
return results
|
||||
|
||||
def format_response(self, item):
|
||||
d = item.as_dict()
|
||||
d = {
|
||||
'id': d.get('id'),
|
||||
'resource_group': self.parse_resource_to_dict(d.get('id')).get('resource_group'),
|
||||
'name': d.get('name', None),
|
||||
'location': d.get('location', '').replace(' ', '').lower(),
|
||||
'kind': _camel_to_snake(d.get('kind', None)),
|
||||
'consistency_policy': {'default_consistency_level': _camel_to_snake(d['consistency_policy']['default_consistency_level']),
|
||||
'max_interval_in_seconds': d['consistency_policy']['max_interval_in_seconds'],
|
||||
'max_staleness_prefix': d['consistency_policy']['max_staleness_prefix']},
|
||||
'failover_policies': [{'name': fp['location_name'].replace(' ', '').lower(),
|
||||
'failover_priority': fp['failover_priority'],
|
||||
'id': fp['id']} for fp in d['failover_policies']],
|
||||
'read_locations': [{'name': rl['location_name'].replace(' ', '').lower(),
|
||||
'failover_priority': rl['failover_priority'],
|
||||
'id': rl['id'],
|
||||
'document_endpoint': rl['document_endpoint'],
|
||||
'provisioning_state': rl['provisioning_state']} for rl in d['read_locations']],
|
||||
'write_locations': [{'name': wl['location_name'].replace(' ', '').lower(),
|
||||
'failover_priority': wl['failover_priority'],
|
||||
'id': wl['id'],
|
||||
'document_endpoint': wl['document_endpoint'],
|
||||
'provisioning_state': wl['provisioning_state']} for wl in d['write_locations']],
|
||||
'database_account_offer_type': d.get('database_account_offer_type'),
|
||||
'ip_range_filter': d['ip_range_filter'],
|
||||
'is_virtual_network_filter_enabled': d.get('is_virtual_network_filter_enabled'),
|
||||
'enable_automatic_failover': d.get('enable_automatic_failover'),
|
||||
'enable_cassandra': 'EnableCassandra' in d.get('capabilities', []),
|
||||
'enable_table': 'EnableTable' in d.get('capabilities', []),
|
||||
'enable_gremlin': 'EnableGremlin' in d.get('capabilities', []),
|
||||
'virtual_network_rules': d.get('virtual_network_rules'),
|
||||
'enable_multiple_write_locations': d.get('enable_multiple_write_locations'),
|
||||
'document_endpoint': d.get('document_endpoint'),
|
||||
'provisioning_state': d.get('provisioning_state'),
|
||||
'tags': d.get('tags', None)
|
||||
}
|
||||
|
||||
if self.retrieve_keys == 'all':
|
||||
keys = self.mgmt_client.database_accounts.list_keys(resource_group_name=self.resource_group,
|
||||
account_name=self.name)
|
||||
d['primary_master_key'] = keys.primary_master_key
|
||||
d['secondary_master_key'] = keys.secondary_master_key
|
||||
d['primary_readonly_master_key'] = keys.primary_readonly_master_key
|
||||
d['secondary_readonly_master_key'] = keys.secondary_readonly_master_key
|
||||
elif self.retrieve_keys == 'readonly':
|
||||
keys = self.mgmt_client.database_accounts.get_read_only_keys(resource_group_name=self.resource_group,
|
||||
account_name=self.name)
|
||||
d['primary_readonly_master_key'] = keys.primary_readonly_master_key
|
||||
d['secondary_readonly_master_key'] = keys.secondary_readonly_master_key
|
||||
if self.retrieve_connection_strings:
|
||||
connection_strings = self.mgmt_client.database_accounts.list_connection_strings(resource_group_name=self.resource_group,
|
||||
account_name=self.name)
|
||||
d['connection_strings'] = connection_strings.as_dict()
|
||||
return d
|
||||
|
||||
|
||||
def main():
|
||||
AzureRMCosmosDBAccountFacts()
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
|
|
@ -1,3 +1,4 @@
|
|||
cloud/azure
|
||||
destructive
|
||||
shippable/azure/group1
|
||||
azure_rm_cosmosdbaccount_facts
|
||||
|
|
|
|||
|
|
@ -112,6 +112,104 @@
|
|||
that:
|
||||
- output.changed
|
||||
|
||||
- name: Get facts of single account
|
||||
azure_rm_cosmosdbaccount_facts:
|
||||
resource_group: "{{ resource_group }}"
|
||||
name: "{{ dbname }}"
|
||||
register: output
|
||||
|
||||
- name: Assert that facts are returned
|
||||
assert:
|
||||
that:
|
||||
- output.changed == False
|
||||
- output.accounts[0]['id'] != None
|
||||
- output.accounts[0]['resource_group'] != None
|
||||
- output.accounts[0]['name'] != None
|
||||
- output.accounts[0]['location'] != None
|
||||
- output.accounts[0]['kind'] != None
|
||||
- output.accounts[0]['consistency_policy'] != None
|
||||
- output.accounts[0]['failover_policies'] != None
|
||||
- output.accounts[0]['read_locations'] != None
|
||||
- output.accounts[0]['write_locations'] != None
|
||||
- output.accounts[0]['database_account_offer_type'] != None
|
||||
- output.accounts[0]['ip_range_filter'] != None
|
||||
- output.accounts[0]['is_virtual_network_filter_enabled'] != None
|
||||
- output.accounts[0]['enable_automatic_failover'] != None
|
||||
- output.accounts[0]['enable_cassandra'] != None
|
||||
- output.accounts[0]['enable_table'] != None
|
||||
- output.accounts[0]['enable_gremlin'] != None
|
||||
- output.accounts[0]['virtual_network_rules'] != None
|
||||
- output.accounts[0]['enable_multiple_write_locations'] != None
|
||||
- output.accounts[0]['document_endpoint'] != None
|
||||
- output.accounts[0]['provisioning_state'] != None
|
||||
- output.accounts[0]['tags'] != None
|
||||
|
||||
- name: Get facts with keys
|
||||
azure_rm_cosmosdbaccount_facts:
|
||||
resource_group: "{{ resource_group }}"
|
||||
name: "{{ dbname }}"
|
||||
retrieve_keys: all
|
||||
register: output
|
||||
|
||||
- name: Assert that facts are returned
|
||||
assert:
|
||||
that:
|
||||
- output.changed == False
|
||||
- output.accounts[0]['primary_master_key'] != None
|
||||
- output.accounts[0]['secondary_master_key'] != None
|
||||
- output.accounts[0]['primary_readonly_master_key'] != None
|
||||
- output.accounts[0]['secondary_readonly_master_key'] != None
|
||||
|
||||
- name: Get facts with readonly keys
|
||||
azure_rm_cosmosdbaccount_facts:
|
||||
resource_group: "{{ resource_group }}"
|
||||
name: "{{ dbname }}"
|
||||
retrieve_keys: readonly
|
||||
retrieve_connection_strings: yes
|
||||
register: output
|
||||
|
||||
- name: Assert that facts are returned
|
||||
assert:
|
||||
that:
|
||||
- output.changed == False
|
||||
- "'primary_master_key' not in output.accounts[0]"
|
||||
- "'secondary_master_key' not in output.accounts[0]"
|
||||
- output.accounts[0]['primary_readonly_master_key'] != None
|
||||
- output.accounts[0]['secondary_readonly_master_key'] != None
|
||||
- output.accounts[0]['connection_strings'] | length > 0
|
||||
|
||||
- name: List acounts by resource group
|
||||
azure_rm_cosmosdbaccount_facts:
|
||||
resource_group: "{{ resource_group }}"
|
||||
name: "{{ dbname }}"
|
||||
register: output
|
||||
|
||||
- name: Assert that facts are returned
|
||||
assert:
|
||||
that:
|
||||
- output.changed == False
|
||||
- output.accounts[0]['id'] != None
|
||||
- output.accounts[0]['resource_group'] != None
|
||||
- output.accounts[0]['name'] != None
|
||||
- output.accounts[0]['location'] != None
|
||||
- output.accounts[0]['kind'] != None
|
||||
- output.accounts[0]['consistency_policy'] != None
|
||||
- output.accounts[0]['failover_policies'] != None
|
||||
- output.accounts[0]['read_locations'] != None
|
||||
- output.accounts[0]['write_locations'] != None
|
||||
- output.accounts[0]['database_account_offer_type'] != None
|
||||
- output.accounts[0]['ip_range_filter'] != None
|
||||
- output.accounts[0]['is_virtual_network_filter_enabled'] != None
|
||||
- output.accounts[0]['enable_automatic_failover'] != None
|
||||
- output.accounts[0]['enable_cassandra'] != None
|
||||
- output.accounts[0]['enable_table'] != None
|
||||
- output.accounts[0]['enable_gremlin'] != None
|
||||
- output.accounts[0]['virtual_network_rules'] != None
|
||||
- output.accounts[0]['enable_multiple_write_locations'] != None
|
||||
- output.accounts[0]['document_endpoint'] != None
|
||||
- output.accounts[0]['provisioning_state'] != None
|
||||
- output.accounts[0]['tags'] != None
|
||||
|
||||
- name: Delete instance of Database Account -- check mode
|
||||
azure_rm_cosmosdbaccount:
|
||||
resource_group: "{{ resource_group }}"
|
||||
|
|
|
|||
Loading…
Reference in a new issue