Pustaka klien Azure DevCenter Service untuk Python - versi 1.0.0b3

Artikel
11/09/2023

Paket Azure DevCenter menyediakan akses untuk mengelola sumber daya untuk Microsoft Dev Box dan Lingkungan Penyebaran Azure. SDK ini memungkinkan pengelolaan mesin dan lingkungan pengembang di Azure.

Gunakan paket untuk Azure DevCenter untuk:

Membuat, mengakses, mengelola, dan menghapus sumber daya Dev Box Membuat, menyebarkan, mengelola, dan menghapus sumber daya Lingkungan

Memulai

Menginstal paket

python -m pip install azure-developer-devcenter

Prasyarat

Python 3.7 atau yang lebih baru diharuskan untuk menggunakan paket ini.
Anda memerlukan langganan Azure untuk menggunakan paket ini.
Anda harus mengonfigurasi DevCenter, Project, Network Connection, Dev Box Definition, dan Pool sebelum Anda dapat membuat Dev Boxes
Anda harus mengonfigurasi DevCenter, Proyek, Katalog, dan Jenis Lingkungan sebelum Anda dapat membuat Lingkungan

Membuat dengan Kredensial Azure Active Directory

Untuk menggunakan kredensial token Azure Active Directory (AAD), berikan instans jenis kredensial yang diinginkan yang diperoleh dari pustaka identitas azure .

Untuk mengautentikasi dengan AAD, Anda harus terlebih dahulu memasang pip azure-identity

Setelah penyiapan, Anda dapat memilih jenis kredensial mana dari azure.identity yang akan digunakan. Sebagai contoh, DefaultAzureCredential dapat digunakan untuk mengautentikasi klien:

Atur nilai ID klien, ID penyewa, dan rahasia klien aplikasi AAD sebagai variabel lingkungan: AZURE_CLIENT_ID, , AZURE_TENANT_IDAZURE_CLIENT_SECRET

Gunakan kredensial token yang dikembalikan untuk mengautentikasi klien:

>>> import os
>>> from azure.developer.devcenter import DevCenterClient
>>> from azure.identity import DefaultAzureCredential
>>> tenant_id = os.environ['AZURE_TENANT_ID']
>>> endpoint = os.environ["DEVCENTER_ENDPOINT"]
>>> client = DevCenterClient(endpoint, credential=DefaultAzureCredential())

Contoh

Manajemen Dev Box

>>> import os
>>> from azure.developer.devcenter import DevCenterClient
>>> from azure.identity import DefaultAzureCredential
>>> from azure.core.exceptions import HttpResponseError
>>> tenant_id = os.environ['AZURE_TENANT_ID']
>>> endpoint = os.environ["DEVCENTER_ENDPOINT"]
>>> client = DevCenterClient(endpoint, credential=DefaultAzureCredential())
>>> try:
        # 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']

        # 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()

        LOG.info(f"Provisioned dev box with status {devbox_result['provisioningState']}.")

        # Connect to the provisioned dev box
        remote_connection_response = client.get_remote_connection(target_project_name, "me", "Test_DevBox")
        LOG.info(f"Connect to the dev box using web URL {remote_connection_response['webUrl']}")

        # Tear down the dev box when finished
        delete_response = client.begin_delete_dev_box(target_project_name, "me", "Test_DevBox")
        delete_response.wait()
        LOG.info("Deleted dev box successfully.")
    except HttpResponseError as e:
        print('service responds error: {}'.format(e.response.json()))

Manajemen Lingkungan

>>> import os
>>> from azure.developer.devcenter import DevCenterClient
>>> from azure.identity import DefaultAzureCredential
>>> from azure.core.exceptions import HttpResponseError
>>> tenant_id = os.environ['AZURE_TENANT_ID']
>>> endpoint = os.environ["DEVCENTER_ENDPOINT"]
>>> client = DevCenterClient(endpoint, credential=DefaultAzureCredential())
>>> try:
        # Fetch control plane resource dependencies
        target_project_name = list(client.list_projects(top=1))[0]['name']
        target_catalog_item_name = list(client.list_catalog_items(target_project_name, top=1))[0]['name']
        target_environment_type_name = list(client.list_environment_types(target_project_name, top=1))[0]['name']
        target_catalog_name = list(client.list_catalog_items(target_project_name, top=1))[0]['catalogName']

        # Stand up a new environment
        create_response = client.begin_create_or_update_environment(target_project_name,
                                                           "Dev_Environment",
                                                           {"catalogName": target_catalog_name,
                                                            "catalogItemName": target_catalog_item_name,
                                                            "environmentType": target_environment_type_name
                                                            })     
        
        environment_result = create_response.result()

        LOG.info(f"Provisioned environment with status {environment_result['provisioningState']}.")

        # Fetch deployment artifacts
        environment = client.get_environment_by_user(target_project_name, "me", "Dev_Environment")
        LOG.info(environment)

        # Tear down the environment when finished
        delete_response = client.begin_delete_environment(target_project_name, "me", "Dev_Environment")
        delete_response.wait()
        LOG.info("Completed deletion for the environment.")
    except HttpResponseError as e:
        print('service responds error: {}'.format(e.response.json()))

Konsep utama

Dev Box mengacu pada komputer pengembang terkelola yang berjalan di Azure. Dev Box disediakan di Pools, yang menentukan jaringan dan gambar yang digunakan untuk Dev Box.

Lingkungan mengacu pada lingkungan pengembang yang di-template, yang menggabungkan templat (Item Katalog) dan parameter.

Pemecahan Masalah

Kesalahan dapat terjadi selama permintaan awal dan operasi jangka panjang, dan akan memberikan informasi tentang cara mengatasi kesalahan. Pastikan untuk mengonfirmasi bahwa sumber daya dependen, seperti kumpulan dan katalog, disiapkan dengan benar dan dalam keadaan sehat. Anda tidak akan dapat membuat sumber daya dengan paket ketika sumber daya dependen Anda dalam keadaan gagal.

Langkah berikutnya

Mulailah dengan menjelajahi sampel kami dan mulai menggunakan paket!

Berkontribusi

Proyek ini menyambut baik kontribusi dan saran. Sebagian besar kontribusi mengharuskan Anda menyetujui Perjanjian Lisensi Kontributor (CLA) yang menyatakan bahwa Anda memiliki hak untuk, dan benar-benar melakukannya, memberi kami hak untuk menggunakan kontribusi Anda. Untuk detailnya, kunjungi https://cla.microsoft.com.

Ketika Anda mengirimkan permintaan tarik, CLA-bot akan secara otomatis menentukan apakah Anda perlu memberikan CLA dan menghias PR dengan tepat (misalnya, label, komentar). Cukup ikuti instruksi yang diberikan oleh bot. Anda hanya perlu melakukan ini sekali di semua repos menggunakan CLA kami.

Proyek ini telah mengadopsi Kode Etik Sumber Terbuka Microsoft. Untuk informasi selengkapnya, lihat Tanya Jawab Umum Kode Etik atau kontak dengan pertanyaan atau komentar opencode@microsoft.com tambahan.

Bagikan melalui