File: deployment_environments_async_sample.py

package info (click to toggle)
python-azure 20250603%2Bgit-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 851,724 kB
  • sloc: python: 7,362,925; ansic: 804; javascript: 287; makefile: 195; sh: 145; xml: 109
file content (148 lines) | stat: -rw-r--r-- 6,541 bytes parent folder | download
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
# coding=utf-8
# --------------------------------------------------------------------------
#
# Copyright (c) Microsoft Corporation. All rights reserved.
#
# The MIT License (MIT)
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the ""Software""), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.
#
# --------------------------------------------------------------------------

"""
FILE: deployment_environments_async_sample.py

DESCRIPTION:
    This sample demonstrates how to create and delete Environments using python DevCenterClient. For this sample,
    you must have previously configured a DevCenter, Project, Catalog, Environment Definition and Environment Type. 
    More details   on how to configure those requirements at https://learn.microsoft.com/azure/deployment-environments/

USAGE:
    python deployment_environments_async_sample.py

    Set the environment variables with your own values before running the sample:
    1) DEVCENTER_ENDPOINT - the endpoint for your devcenter
"""

import os
import asyncio

from azure.developer.devcenter.aio import DevCenterClient
from azure.identity import DefaultAzureCredential


async def environment_create_and_delete_async():
    # [START environment_create_and_delete_async]
    # Set the values of the dev center endpoint, client ID, and client secret of the AAD application as environment variables:
    # DEVCENTER_ENDPOINT, AZURE_TENANT_ID, AZURE_CLIENT_ID, AZURE_CLIENT_SECRET
    try:
        endpoint = os.environ["DEVCENTER_ENDPOINT"]
    except KeyError:
        raise ValueError("Missing environment variable 'DEVCENTER_ENDPOINT' - please set it before running the example")

    # Build a client through AAD
    client = DevCenterClient(endpoint, credential=DefaultAzureCredential())

    async with client:
        # List available Projects
        projects = []
        async for project in client.list_projects():
            projects.append(project)
        if projects:
            print("\nList of projects: ")
            for project in projects:
                print(f"{project.name}")

            # Select first project in the list
            target_project_name = projects[0].name
        else:
            raise ValueError("Missing Project - please create one before running the example")

        # List available Catalogs
        catalogs = []
        async for catalog in client.list_catalogs(target_project_name):
            catalogs.append(catalog)
        if catalogs:
            print("\nList of catalogs: ")
            for catalog in catalogs:
                print(f"{catalog.name}")

            # Select first catalog in the list
            target_catalog_name = catalogs[0].name
        else:
            raise ValueError("Missing Catalog - please create one before running the example")

        # List available Environment Definitions
        environment_definitions = []
        async for environment_definition in client.list_environment_definitions_by_catalog(target_project_name, target_catalog_name):
            environment_definitions.append(environment_definition)
        if environment_definitions:
            print("\nList of environment definitions: ")
            for environment_definition in environment_definitions:
                print(f"{environment_definition.name}")

            # Select first environment definition in the list
            target_environment_definition_name = environment_definitions[0].name
        else:
            raise ValueError("Missing Environment Definition - please create one before running the example")

        # List available Environment Types
        environment_types = []
        async for environment_type in client.list_environment_types(target_project_name):
            environment_types.append(environment_type)
        if environment_types:
            print("\nList of environment types: ")
            for environment_type in environment_types:
                print(f"{environment_type.name}")

            # Select first environment type in the list
            target_environment_type_name = environment_types[0].name
        else:
            raise ValueError("Missing Environment Type - please create one before running the example")

        print(
            f"\nStarting to create environment in project {target_project_name} with catalog {target_catalog_name}, environment definition {target_environment_definition_name}, and environment type {target_environment_type_name}."
        )

        # Stand up a new environment
        environment_name = "MyDevEnv"
        environment = {
            "environmentType": target_environment_type_name,
            "catalogName": target_catalog_name,
            "environmentDefinitionName": target_environment_definition_name,
        }

        environment_poller = await client.begin_create_or_update_environment(
            target_project_name, "me", environment_name, environment
        )
        environment_result = await environment_poller.result()
        print(f"Provisioned environment with status {environment_result.provisioning_state}.")

        # Tear down the environment when finished
        print(f"Starting to delete environment.")
        delete_poller = await client.begin_delete_environment(target_project_name, "me", environment_name)
        delete_result = await delete_poller.result()
        print(f"Completed deletion for the environment with status {delete_result.status}")
    # [END environment_create_and_delete_async]

async def main():
    await environment_create_and_delete_async()

if __name__ == '__main__':
    asyncio.run(main())