Skip to content
This repository was archived by the owner on Jun 17, 2024. It is now read-only.

Commit 86b11a5

Browse files
author
Ian McCowan
authored
Clarify use of destroy
1 parent e3e785e commit 86b11a5

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -201,15 +201,17 @@ class Deployer(object):
201201
self.client.resource_groups.delete(self.resource_group)
202202
```
203203

204-
The `__init__` method initializes the class with subscription, resource group and public key. The method also fetches
204+
The `__init__` method initializes the class with the subscription, resource group and public key. The method also fetches
205205
the Azure Active Directory bearer token, which will be used in each HTTP request to the Azure Management API. The class
206206
will raise exceptions under two conditions: if the public key path does not exist, or if there are empty
207-
values for Tenant Id, Client Id or Client Secret environment variables.
207+
values for `AZURE_TENANT_ID`, `AZURE_CLIENT_ID` or `AZURE_CLIENT_SECRET` environment variables.
208208

209-
The `deploy` method does the heavy lifting of creating or updating the resource group, preparing the template,
209+
The `deploy` method does the heavy lifting of creating or updating the resource group, preparing the template
210210
parameters and deploying the template.
211211

212212
The `destroy` method simply deletes the resource group thus deleting all of the resources within that group.
213+
Note that it is commented out in `azure_deployment.py`. But you can uncomment it to easily clean up the resources
214+
created by this sample if you no longer need them.
213215

214216
Each of the above methods use the `azure.mgmt.resource.ResourceManagementClient` class, which resides within the
215217
[azure-mgmt-resource](https://pypi.python.org/pypi/azure-mgmt-resource/) package ([see the docs here](http://azure-sdk-for-python.readthedocs.io/en/latest/resourcemanagement.html)).

0 commit comments

Comments
 (0)