Add samples

sdk/devcenter/azure-developer-devcenter/samples/create_devbox_sample.py

@@ -24,13 +24,6 @@
 # IN THE SOFTWARE.
 #
 # --------------------------------------------------------------------------
-import logging
-import os
-
-from azure.developer.devcenter import DevCenterClient
-from azure.identity import DefaultAzureCredential
-from azure.core.exceptions import HttpResponseError
-
 """
 FILE: create_devbox_sample.py
 
@@ -48,8 +41,15 @@
 """
 
 
+
+import os
+
+from azure.developer.devcenter import DevCenterClient
+from azure.identity import DefaultAzureCredential
+
+
 def get_project_name(LOG, client):
-    projects = list(client.projects.list_by_dev_center(top=1))
+    projects = list(client.projects.list_by_dev_center)
     return projects[0].name
 
 
@@ -65,30 +65,51 @@ def main():
     # Build a client through AAD
     client = DevCenterClient(endpoint, credential=DefaultAzureCredential())
 
-    # Fetch control plane resource dependencies
-    projects = list(client.list_projects(top=1))
-    target_project_name = projects[0]["name"]
-
-    pools = list(client.list_pools(target_project_name, top=1))
-    target_pool_name = pools[0]["name"]
+    # [START create_dt_client_with_key]
+    # List available Projects 
+    projects = client.list_projects()
+    if projects:
+        print("\nList of projects: ")
+        for project in projects:
+            print(f"{project.name}")
+
+        # Select first project in the list
+        target_project_name = list(projects)[0].name
+    else:
+        raise ValueError("Missing Project - please create one before running the example")
+    # [END create_dt_client_with_key]
+
+    # List available Pools
+    pools = client.list_pools(target_pool_name)
+    if pools:
+        print("\nList of pools: ")
+        for pool in pools:
+            print(f"{pool.name}")
+
+        # Select first pool in the list
+        target_pool_name = list(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 devbox in project {target_project_name} and pool {target_pool_name}")
 
-    # Stand up a new dev box
     create_response = client.begin_create_dev_box(
         target_project_name, "me", "Test_DevBox", {"poolName": target_pool_name}
     )
-    devbox_result = create_response.result()
+    devbox = create_response.result()
+    print(f"Provisioned dev box with status {devbox.provisioning_state}.")
 
-    print(f"Provisioned dev box with status {devbox_result['provisioningState']}.")
+    # Connect to the provisioned Dev Box
+    remote_connection = client.get_remote_connection(target_project_name, "me", devbox.name)
+    print(f"Connect to the dev box using web URL {remote_connection.web_url}")
 
-    # Connect to the provisioned dev box
-    remote_connection_response = client.get_remote_connection(target_project_name, "me", "Test_DevBox")
-    print(f"Connect to the dev box using web URL {remote_connection_response['webUrl']}")
+    # Tear down the Dev Box when finished
+    print(f"Starting to delete dev box.") 
 
-    # Tear down the dev box when finished
     delete_response = client.begin_delete_dev_box(target_project_name, "me", "Test_DevBox")
-    delete_response.wait()
-    print("Deleted dev box successfully.")
-
+    delete_result = delete_response.result()
+    print(f"Completed deletion for the dev box with status {delete_result.status}")
 
 if __name__ == "__main__":
     main()

sdk/devcenter/azure-developer-devcenter/samples/create_environment_sample.py

@@ -36,8 +36,8 @@
 
 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, and Environment Type. More details 
-    on how to configure those requirements at https://learn.microsoft.com/azure/deployment-environments/
+    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 create_environment_sample.py
@@ -46,7 +46,6 @@
     1) DEVCENTER_ENDPOINT - the endpoint for your devcenter
 """
 
-
 def main():
 
     # Set the values of the dev center endpoint, client ID, and client secret of the AAD application as environment variables:
@@ -59,31 +58,76 @@ def main():
     # Build a client through AAD
     client = DevCenterClient(endpoint, credential=DefaultAzureCredential())
 
-    # Fetch control plane resource dependencies
-    target_project_name = list(client.list_projects(top=1))[0]["name"]
-    target_catalog_name = list(client.list_catalogs(target_project_name, top=1))[0]["name"]
-    target_environment_definition_name = list(
-        client.list_environment_definitions_by_catalog(target_project_name, target_catalog_name, top=1)
-    )[0]["name"]
-    target_environment_type_name = list(client.list_environment_types(target_project_name, top=1))[0]["name"]
+    # List available Projects 
+    projects = client.list_projects()
+    if projects:
+        print("\nList of projects: ")
+        for project in projects:
+            print(f"{project.name}")
+
+        # Select first project in the list
+        target_project_name = list(projects)[0].name
+    else:
+        raise ValueError("Missing Project - please create one before running the example")
+
+    # List available Catalogs 
+    catalogs = client.list_catalogs(target_project_name)
+    if catalogs:
+        print("\nList of catalogs: ")
+        for catalog in catalogs:
+            print(f"{catalog.name}")
+
+        # Select first catalog in the list
+        target_catalog_name = list(catalogs)[0].name
+    else:
+        raise ValueError("Missing Catalog - please create one before running the example")
+
+    # List available Environment Definitions 
+    environment_definitions = client.list_environment_definitions_by_catalog(target_project_name, target_catalog_name)
+    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 = list(environment_definitions)[0].name
+    else:
+        raise ValueError("Missing Environment Definition - please create one before running the example")
+
+    # List available Environment Types 
+    environment_types = client.list_environment_types(target_project_name)
+    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 = list(environment_types)[0].name
+    else:
+        raise ValueError("Missing Environment Type - please create one before running the example")
+
+    target_environment_type_name = list()[0].name
+
+    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,
-        "environmentType": target_environment_type_name,
     }
 
-    create_response = client.begin_create_or_update_environment(target_project_name, "me", "DevTestEnv", environment)
+    create_response = client.begin_create_or_update_environment(target_project_name, "me", environment_name, environment)
     environment_result = create_response.result()
-
-    print(f"Provisioned environment with status {environment_result['provisioningState']}.")
+    print(f"Provisioned environment with status {environment_result.provisioning_state}.")
 
     # Tear down the environment when finished
-    delete_response = client.begin_delete_environment(target_project_name, "me", "DevTestEnv")
+    print(f"Starting to delete environment.") 
+    delete_response = client.begin_delete_environment(target_project_name, "me", environment_name)
     delete_result = delete_response.result()
-    print(f"Completed deletion for the environment with status {delete_result['status']}")
-
+    print(f"Completed deletion for the environment with status {delete_result.status}")
 
 if __name__ == "__main__":
     main()

sdk/devcenter/azure-developer-devcenter/samples/devbox_action_sample copy.py

@@ -0,0 +1,95 @@
+# 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
+
+from azure.developer.devcenter import DevCenterClient
+from azure.identity import DefaultAzureCredential
+from datetime import timedelta
+
+"""
+FILE: create_devbox_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 create_devbox_sample.py in this folder
+
+USAGE:
+    python create_devbox_sample.py
+
+    Set the environment variables with your own values before running the sample:
+    1) DEVCENTER_ENDPOINT - the endpoint for your devcenter
+"""
+
+def get_project_name(LOG, client):
+    projects = list(client.projects.list_by_dev_center)
+    return projects[0].name
+
+
+def main():
+
+    # Set the values of the dev center endpoint, client ID, and client secret of the AAD application as environment variables:
+    # DEVCENTER_ENDPOINT, 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 = client.list_all_dev_boxes_by_user("me")
+    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 = list(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 = 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 = 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
+    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")
+
+if __name__ == "__main__":
+    main()