add aync samples

sdk/devcenter/azure-developer-devcenter/samples/async_samples/deployment_environments_async_sample.py

@@ -0,0 +1,147 @@
+# 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]
+    # 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())
+
+    # 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 def main():
+    await environment_create_and_delete_async()
+
+if __name__ == '__main__':
+    asyncio.run(main())

sdk/devcenter/azure-developer-devcenter/samples/async_samples/dev_box_action_async_sample.py

@@ -0,0 +1,98 @@
+# 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.
+#
+# --------------------------------------------------------------------------
+import os
+import asyncio
+
+from azure.developer.devcenter.aio import DevCenterClient
+from azure.identity import DefaultAzureCredential
+from datetime import timedelta
+
+"""
+FILE: dev_box_action_async_sample.py
+
+DESCRIPTION:
+    This sample demonstrates how to get, delay and skip a dev box action using python DevCenterClient. 
+    For this sample, you must have a running dev box created from a pool with auto-stop enabled. More details  
+    on how to configure auto-stop at https://learn.microsoft.com/azure/dev-box/how-to-configure-stop-schedule
+    and sample on how to create a dev box at dev_box_create_sample.py in this folder
+
+USAGE:
+    python dev_box_action_async_sample.py
+
+    Set the environment variables with your own values before running the sample:
+    1) DEVCENTER_ENDPOINT - the endpoint for your devcenter
+"""
+
+async def dev_box_action_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())
+
+    # List Dev Boxes
+    dev_boxes = []
+    async for dev_box in client.list_all_dev_boxes_by_user("me"):
+        dev_boxes.append(dev_box)
+    if dev_boxes:
+        print("List of dev boxes: ")
+        for dev_box in dev_boxes:
+            print(f"{dev_box.name}")
+
+        # Select first dev box in the list
+        target_dev_box = dev_boxes[0]
+    else:
+        raise ValueError("Missing Dev Box - please create one before running the example.")
+
+    # Get the schedule default action. This action should exist for dev boxes created with auto-stop enabled
+    action = await client.get_dev_box_action(target_dev_box.project_name, "me", target_dev_box.name, "schedule-default")
+    next_action_time = action.next.scheduled_time
+    print(f"\nAction {action.Name} is schedule to {action.ActionType} at {next_action_time}.")
+
+    # Delay the action in 1hr
+    delay_until = next_action_time + timedelta(hours=1)
+    delayed_action = await client.delay_dev_box_action(
+        target_dev_box.project_name, "me", target_dev_box.name, action.name, delay_until=delay_until
+    )
+    print(
+        f"\nAction {delayed_action.Name} has been delayed and is now schedule to {delayed_action.ActionType} at {delayed_action.NextAction.ScheduledTime}."
+    )
+
+    # Skip the default schedule action
+    await client.skip_dev_box_action(target_dev_box.project_name, "me", target_dev_box.name, "schedule-default")
+    print(f"\nThe scheduled auto-stop action in dev box {target_dev_box.name} has been skipped")
+
+async def main():
+    await dev_box_action_async()
+
+if __name__ == '__main__':
+    asyncio.run(main())

sdk/devcenter/azure-developer-devcenter/samples/async_samples/dev_box_create_async_sample.py

@@ -0,0 +1,113 @@
+# 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: dev_box_create_async_sample.py
+
+DESCRIPTION:
+    This sample demonstrates how to create, connect and delete a dev box using python DevCenterClient. For this sample,
+    you must have previously configured DevCenter, Project, Network Connection, Dev Box Definition, and Pool.More details 
+    on how to configure those requirements at https://learn.microsoft.com/azure/dev-box/quickstart-configure-dev-box-service
+
+
+USAGE:
+    python dev_box_create_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 dev_box_create_connect_delete_async():
+    # [START dev_box_create_connect_delete]
+    # 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())
+
+    # 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 Pools
+    pools = []
+    async for pool in client.list_pools(target_project_name):
+        pools.append(pool)
+    if pools:
+        print("\nList of pools: ")
+        for pool in pools:
+            print(f"{pool.name}")
+
+        # Select first pool in the list
+        target_pool_name = pools[0].name
+    else:
+        raise ValueError("Missing Pool - please create one before running the example")
+
+    # Stand up a new Dev Box
+    print(f"\nStarting to create dev box in project {target_project_name} and pool {target_pool_name}")
+
+    dev_box_poller = await client.begin_create_dev_box(
+        target_project_name, "me", "Test_DevBox", {"poolName": target_pool_name}
+    )
+    dev_box = await dev_box_poller.result()
+    print(f"Provisioned dev box with status {dev_box.provisioning_state}.")
+
+    # Connect to the provisioned Dev Box
+    remote_connection = await client.get_remote_connection(target_project_name, "me", dev_box.name)
+    print(f"Connect to the dev box using web URL {remote_connection.web_url}")
+
+    # Tear down the Dev Box when finished
+    print(f"Starting to delete dev box.")
+
+    delete_poller = await client.begin_delete_dev_box(target_project_name, "me", "Test_DevBox")
+    delete_result = await delete_poller.result()
+    print(f"Completed deletion for the dev box with status {delete_result.status}")
+    # [END dev_box_create_connect_delete]
+
+async def main():
+    await dev_box_create_connect_delete_async()
+
+if __name__ == '__main__':
+    asyncio.run(main())