add azure account methods, and fix readme examples

Author: hakutsuru

README.md

@@ -30,16 +30,17 @@ This SDK requires a [Cloudcraft API key](https://developers.cloudcraft.co/#authe
 ## Installation
 
 ```
-python -m pip install cloudcraftco
+python3.10 -m pip install cloudcraftco
 ```
 
 ## Usage
 
 The API is accessed through the `Cloudcraft` class. An API key available through the Cloudcraft user interface is required when instantiating `Cloudcraft`. It can be passed to the class as an argument or through the `CLOUDCRAFT_API_KEY` environment variable:
 
 ```python
-from cloudcraftco import Cloudcraft
+from cloudcraftco.cloudcraft import Cloudcraft
 
+# assumes CLOUDCRAFT_API_KEY exported
 cloudcraft = Cloudcraft()
 
 profile = cloudcraft.read_user_profile()
@@ -52,7 +53,7 @@ profile = cloudcraft.read_user_profile()
 The package can be initialized with several options:
 
 ```python
-from cloudcraftco import Cloudcraft
+from cloudcraftco.cloudcraft import Cloudcraft
 
 cloudcraft = Cloudcraft({"api_key": "api-key-value", "timeout": 30000})
 ```
@@ -85,6 +86,9 @@ Options may also be specified by environment variable...
 #### List blueprints
 
 ```python
+from cloudcraftco.cloudcraft import Cloudcraft
+
+# assumes CLOUDCRAFT_API_KEY exported
 cloudcraft = Cloudcraft()
 
 blueprints = cloudcraft.list_blueprints()
@@ -93,6 +97,9 @@ blueprints = cloudcraft.list_blueprints()
 #### Retrieve blueprint
 
 ```python
+from cloudcraftco.cloudcraft import Cloudcraft
+
+# assumes CLOUDCRAFT_API_KEY exported
 cloudcraft = Cloudcraft()
 
 blueprint_id = "BLUEPRINT-ID" # valid blueprint uuid
@@ -102,6 +109,9 @@ blueprint = cloudcraft.read_blueprint(blueprint_id)
 #### Create blueprint
 
 ```python
+from cloudcraftco.cloudcraft import Cloudcraft
+
+# assumes CLOUDCRAFT_API_KEY exported
 cloudcraft = Cloudcraft()
 
 data = {"data": {"grid": "standard", "name": "New blueprint"}}
@@ -111,16 +121,34 @@ blueprint = cloudcraft.create_blueprint(data)
 #### Update blueprint
 
 ```python
+from cloudcraftco.cloudcraft import Cloudcraft
+
+# assumes CLOUDCRAFT_API_KEY exported
 cloudcraft = Cloudcraft()
 
 blueprint_id = "BLUEPRINT-ID" # valid blueprint uuid
 data = {"data": {"grid": "standard", "name": "Updated blueprint"}}
 cloudcraft.update_blueprint(blueprint_id, data)
 ```
 
+#### Delete blueprint
+
+```python
+from cloudcraftco.cloudcraft import Cloudcraft
+
+# assumes CLOUDCRAFT_API_KEY exported
+cloudcraft = Cloudcraft()
+
+blueprint_id = "BLUEPRINT-ID" # valid blueprint uuid
+cloudcraft.delete_blueprint(blueprint_id)
+```
+
 #### Export blueprint as image
 
 ```python
+from cloudcraftco.cloudcraft import Cloudcraft
+
+# assumes CLOUDCRAFT_API_KEY exported
 cloudcraft = Cloudcraft()
 script_dir = os.path.dirname(os.path.realpath(__file__)) + os.sep
 
@@ -133,20 +161,14 @@ with open(bp_file, "wb") as binary_file:
     binary_file.write(export)
 ```
 
-#### Delete blueprint
-
-```python
-cloudcraft = Cloudcraft()
-
-blueprint_id = "BLUEPRINT-ID" # valid blueprint uuid
-cloudcraft.delete_blueprint(blueprint_id)
-```
-
 ### AWS Accounts
 
 #### Add AWS account
 
 ```python
+from cloudcraftco.cloudcraft import Cloudcraft
+
+# assumes CLOUDCRAFT_API_KEY exported
 cloudcraft = Cloudcraft()
 
 # role must exist and match your api_key/account
@@ -158,14 +180,57 @@ result = cloudcraft.create_aws_account(data)
 #### List AWS accounts
 
 ```python
+from cloudcraftco.cloudcraft import Cloudcraft
+
+# assumes CLOUDCRAFT_API_KEY exported
 cloudcraft = Cloudcraft()
 
 accounts = cloudcraft.list_aws_accounts()
 ```
 
+#### Update AWS account
+
+```python
+from cloudcraftco.cloudcraft import Cloudcraft
+
+# assumes CLOUDCRAFT_API_KEY exported
+cloudcraft = Cloudcraft()
+
+account_id = "AWS-ACCOUNT" # valid account uuid for api-key
+role = "AWS-ROLE" # valid role for AWS Account
+data = {"name": "Updated Playground AWS Account", "roleArn": role}
+result = cloudcraft.update_aws_account(account_id, data)
+```
+
+#### Delete AWS account
+
+```python
+from cloudcraftco.cloudcraft import Cloudcraft
+
+# assumes CLOUDCRAFT_API_KEY exported
+cloudcraft = Cloudcraft()
+
+account_id = "AWS-ACCOUNT" # valid account uuid for api-key
+cloudcraft.delete_aws_account(account_id)
+```
+
+#### Get my AWS IAM Role parameters
+
+```python
+from cloudcraftco.cloudcraft import Cloudcraft
+
+# assumes CLOUDCRAFT_API_KEY exported
+cloudcraft = Cloudcraft()
+
+iam_parameters = cloudcraft.read_aws_role_parameters()
+```
+
 #### Snapshot AWS account
 
 ```python
+from cloudcraftco.cloudcraft import Cloudcraft
+
+# assumes CLOUDCRAFT_API_KEY exported
 cloudcraft = Cloudcraft()
 script_dir = os.path.dirname(os.path.realpath(__file__)) + os.sep
 
@@ -179,39 +244,95 @@ with open(ss_file, "wb") as binary_file:
     binary_file.write(snapshot)
 ```
 
-#### Update AWS account
+### Azure Accounts
+
+#### Add Azure account
 
 ```python
+from cloudcraftco.cloudcraft import Cloudcraft
+
+# assumes CLOUDCRAFT_API_KEY exported
 cloudcraft = Cloudcraft()
 
-account_id = "AWS-ACCOUNT" # valid account uuid for api-key
-role = "AWS-ROLE" # valid role for AWS Account
-data = {"name": "Updated Playground AWS Account.", "roleArn": role}
-result = cloudcraft.update_aws_account(account_id, data)
+# id and secret values must be valid
+data = {
+    "name": "Azure Account",
+    "subscriptionId": "subscriptionId",
+    "directoryId": "directoryId",
+    "applicationId": "applicationId",
+    "clientSecret": "clientSecret"
+}
+result = cloudcraft.create_azure_account(data)
 ```
 
-#### Delete AWS account
+#### List Azure accounts
 
 ```python
+from cloudcraftco.cloudcraft import Cloudcraft
+
+# assumes CLOUDCRAFT_API_KEY exported
 cloudcraft = Cloudcraft()
 
-account_id = "AWS-ACCOUNT" # valid account uuid for api-key
-cloudcraft.delete_aws_account(account_id)
+accounts = cloudcraft.list_azure_accounts()
 ```
 
-#### Get my AWS IAM Role parameters
+#### Update Azure account
 
 ```python
+from cloudcraftco.cloudcraft import Cloudcraft
+
+# assumes CLOUDCRAFT_API_KEY exported
 cloudcraft = Cloudcraft()
 
-iam_parameters = cloudcraft.read_aws_role_parameters()
+account_id = "AZURE-ACCOUNT" # valid account uuid for api-key
+data = {
+    "name": "Updated Azure Account",
+    "subscriptionId": "subscriptionId",
+    "directoryId": "directoryId",
+    "applicationId": "applicationId",
+}
+result = cloudcraft.update_azure_account(account_id, data)
+```
+
+#### Delete Azure account
+
+```python
+from cloudcraftco.cloudcraft import Cloudcraft
+
+# assumes CLOUDCRAFT_API_KEY exported
+cloudcraft = Cloudcraft()
+
+account_id = "AZURE-ACCOUNT" # valid account uuid for api-key
+cloudcraft.delete_azure_account(account_id)
+```
+
+#### Snapshot Azure account
+
+```python
+from cloudcraftco.cloudcraft import Cloudcraft
+
+# assumes CLOUDCRAFT_API_KEY exported
+cloudcraft = Cloudcraft()
+script_dir = os.path.dirname(os.path.realpath(__file__)) + os.sep
+
+ss_account = "AZURE-ACCOUNT" # valid account uuid for api-key
+ss_location = "canadaeast"
+ss_format = "png"
+ss_file = script_dir + ss_location + "." + ss_format
+snapshot = cloudcraft.snapshot_azure_account(ss_account, ss_location, ss_format)
+
+with open(ss_file, "wb") as binary_file:
+    binary_file.write(snapshot)
 ```
 
 ### Budgets
 
 #### Export budget for a blueprint
 
 ```python
+from cloudcraftco.cloudcraft import Cloudcraft
+
+# assumes CLOUDCRAFT_API_KEY exported
 cloudcraft = Cloudcraft()
 script_dir = os.path.dirname(os.path.realpath(__file__)) + os.sep
 
@@ -229,6 +350,9 @@ with open(bp_file, "wb") as binary_file:
 #### Get Cloudcraft account info
 
 ```python
+from cloudcraftco.cloudcraft import Cloudcraft
+
+# assumes CLOUDCRAFT_API_KEY exported
 cloudcraft = Cloudcraft()
 
 profile = cloudcraft.read_user_profile()
@@ -264,14 +388,21 @@ Testing accounts requires care, since creating an account requires valid role.
 % cd {repo-directory}
 % poetry env use python3.10
 % poetry shell
+% poetry install
 % export CLOUDCRAFT_API_KEY={{ api-key }}
-% export CLOUDCRAFT_TEST_ROLE={{ your-test-role-arn }}
-% python3 dev_playgrounds/accounts.py
 % python3 dev_playgrounds/blueprints.py
 % python3 dev_playgrounds/budgets.py
 % python3 dev_playgrounds/exports.py
-% python3 dev_playgrounds/snapshots.py
+% python3 dev_playgrounds/snapshots_aws.py
+% python3 dev_playgrounds/snapshots_azure.py
 % python3 dev_playgrounds/users.py
+% export CLOUDCRAFT_TEST_ROLE={{ your-role-arn }}
+% python3 dev_playgrounds/accounts_aws.py
+% export CLOUDCRAFT_TEST_SUBSCRIPTION={{ your-subscription-id }}
+% export CLOUDCRAFT_TEST_DIRECTORY={{ your-directory-id }}
+% export CLOUDCRAFT_TEST_APPLICATION={{ your-application-id }}
+% export CLOUDCRAFT_TEST_SECRET={{ your-client-secret }}
+% python3 dev_playgrounds/accounts_azure.py
 ```
 
 ### Running Tests

cloudcraftco/api_account.py

@@ -76,3 +76,69 @@ def snapshot_aws_account_handler(
         timeout=cloudcraft.timeout_seconds,
         params=options,
     )
+
+
+def list_azure_accounts_handler(cloudcraft):
+    """List Azure account records via Cloudcraft api."""
+    # /azure/account
+    # method: get
+    api_route = "/azure/account"
+    url = cloudcraft.url_base.format(api_route)
+    return requests.get(
+        url, headers=cloudcraft.headers, timeout=cloudcraft.timeout_seconds
+    )
+
+
+def create_azure_account_handler(cloudcraft, data):
+    """Create Azure account record via Cloudcraft api."""
+    # /azure/account
+    # method: post
+    api_route = "/azure/account"
+    url = cloudcraft.url_base.format(api_route)
+    return requests.post(
+        url, json=data, headers=cloudcraft.headers, timeout=cloudcraft.timeout_seconds
+    )
+
+
+def update_azure_account_handler(cloudcraft, account_id, data):
+    """Update Azure account record via Cloudcraft api."""
+    # /azure/account/{id}
+    # method: put
+    api_route = "/azure/account/" + account_id
+    url = cloudcraft.url_base.format(api_route)
+    return requests.put(
+        url, json=data, headers=cloudcraft.headers, timeout=cloudcraft.timeout_seconds
+    )
+
+
+def delete_azure_account_handler(cloudcraft, account_id):
+    """Delete Azure account record via Coudcraft api."""
+    # /azure/account/{id}
+    # method: delete
+    api_route = "/azure/account/" + account_id
+    url = cloudcraft.url_base.format(api_route)
+    return requests.delete(
+        url, headers=cloudcraft.headers, timeout=cloudcraft.timeout_seconds
+    )
+
+
+def snapshot_azure_account_handler(
+    cloudcraft, account_id, location, ss_format, options=None
+):
+    """Request Azure account snapshot via Cloudcraft api."""
+    # /azure/account/{id}/{location}/{format}
+    # with: optional query parameters
+    # method: get
+    # location: azure location, e.g. "eastus"
+    # format in ["json", "svg", "png", "pdf", "mxGraph"]
+    # options is dist of optional parameters
+    if options is None:
+        options = {}
+    api_route = "/azure/account/{}/{}/{}".format(account_id, location, ss_format)
+    url = cloudcraft.url_base.format(api_route)
+    return requests.get(
+        url,
+        headers=cloudcraft.headers,
+        timeout=cloudcraft.timeout_seconds,
+        params=options,
+    )