Mengelola paket Python 3 di Azure Automation

Artikel ini menjelaskan cara mengimpor, mengelola, dan menggunakan paket Python 3 di Azure Automation yang berjalan di lingkungan kotak pasir Azure dan Hybrid Runbook Workers. Paket Python harus diunduh pada pekerja Runbook Hibrid untuk keberhasilan eksekusi pekerjaan. Untuk membantu menyederhanakan runbook, Anda dapat menggunakan paket Python untuk mengimpor modul yang Anda butuhkan.

Untuk informasi tentang mengelola paket Python 2, lihat Mengelola paket Python 2.

Paket Python default

Untuk mendukung runbook Python 3.8 di layanan Automation, beberapa paket Python diinstal secara default dan daftar paket ini tersedia di sini. Versi default dapat diganti dengan mengimpor paket Python ke akun Automation Anda.

Versi default dapat diganti dengan mengadopsi paket Python ke akun Automation Anda. Untuk mengimpor satu paket, lihat Mengimpor paket. Untuk mengimpor paket dengan beberapa paket, lihat Mengimpor paket dengan dependensi.

Paket sebagai file sumber

Azure Automation hanya mendukung paket Python yang hanya berisi kode Python dan tidak menyertakan ekstensi atau kode bahasa lain dalam bahasa lain. Namun, lingkungan Azure Sandbox mungkin tidak memiliki kompiler yang diperlukan untuk binari C/C ++, jadi disarankan untuk menggunakan file roda sebagai gantinya.

Indeks Paket Python (PyPI) adalah repositori perangkat lunak untuk bahasa pemrograman Python. Saat memilih paket Python 3 untuk diimpor ke akun Automation Anda dari PyPI, perhatikan bagian nama file berikut:

Pilih versi Python:

Mengimpor paket

1. Di akun Automation Anda, pilih Paket Python di bawah Sumber Daya Bersama. Kemudian, pilih + Tambahkan paket Python.

   

2. Pada halaman Tambahkan Paket Python, pilih paket lokal untuk diunggah. Paket dapat berupa file .whl atau .tar.gz untuk Python 3.8 dan file .whl untuk Python 3.10 (pratinjau).

3. Masukkan nama dan pilih Versi Runtime sebagai Python 3.8 atau Python 3.10 (pratinjau)

   Catatan

   Saat ini, versi runtime Python 3.10 (pratinjau) didukung untuk pekerjaan Cloud dan Hybrid di semua wilayah Publik kecuali awan Australia Tengah2, Korea Selatan, Swedia Selatan, Jio India Tengah, Brasil Tenggara, India Tengah, India Barat, UEA Tengah, dan Gov.

4. Pilih impor.

   

Setelah sebuah paket diimpor, paket tersebut terdaftar di halaman paket Python di akun Automation Anda. Untuk menghapus paket, pilih paket dan pilih Hapus.

Mengimpor paket dengan dependensi

Anda dapat mengimpor paket Python 3.8 dan dependensinya dengan mengimpor skrip Python berikut ke dalam runbook Python 3.8. Pastikan Identitas terkelola telah diaktifkan untuk akun Automation Anda dan memiliki akses Kontributor Automation untuk keberhasilan pengimporan paket.

https://github.com/azureautomation/runbooks/blob/master/Utility/Python/import_py3package_from_pypi.py

import requests
import sys
import pip
import os
import re
import shutil
import json
import time
import getopt

#region Constants
PYPI_ENDPOINT = "https://pypi.org/simple"
FILENAME_PATTERN = "[\\w]+"
#endregion

def get_automation_usi_token():
    """ Returns a token that can be used to authenticate against Azure resources """
    import json

    # printing environment variables 
    resource = "?resource=https://management.azure.com/" 
    client_id = "&client_id="+client_id_usi 
    endPoint = os.getenv('IDENTITY_ENDPOINT')+ resource +client_id 
    identityHeader = os.getenv('IDENTITY_HEADER') 
    payload={}
    headers = {
      'X-IDENTITY-HEADER': identityHeader,
      'Metadata': 'True' 
    }
    response = requests.request("GET", endPoint, headers=headers, data=payload) 

    # Return the token
    return json.loads(response.text)['access_token']

def get_packagename_from_filename(packagefilename):
    match = re.match(FILENAME_PATTERN, packagefilename)
    return match.group(0)

def resolve_download_url(packagename, packagefilename):
    response = requests.get("%s/%s" % (PYPI_ENDPOINT, packagename))
    urls = re.findall(r'href=[\'"]?([^\'" >]+)', str(response.content))   
    for url in urls:
        if packagefilename in url:
            print ("Detected download uri %s for %s" % (url, packagename))
            return(url)

def send_webservice_import_module_request(packagename, download_uri_for_file):
    request_url = "https://management.azure.com/subscriptions/%s/resourceGroups/%s/providers/Microsoft.Automation/automationAccounts/%s/python3Packages/%s?api-version=2018-06-30" \
                  % (subscription_id, resource_group, automation_account, packagename)

    requestbody = { 'properties': { 'description': 'uploaded via automation', 'contentLink': {'uri': "%s" % download_uri_for_file} } }
    headers = {'Content-Type' : 'application/json', 'Authorization' : "Bearer %s" % token}
    r = requests.put(request_url, data=json.dumps(requestbody), headers=headers)
    print ("Request status for package %s was %s" % (packagename, str(r.status_code)))
    if str(r.status_code) not in ["200", "201"]:
        raise Exception("Error importing package {0} into Automation account. Error code is {1}".format(packagename, str(r.status_code)))

def make_temp_dir():
    destdir = os.path._getfullpathname("tempDownloadDir")
    if os.path.exists(destdir):
        shutil.rmtree(destdir)
    os.makedirs(destdir, 0o755)
    return destdir

def import_package_with_dependencies (packagename):
    # download package with all dependencies
    download_dir = make_temp_dir()
    pip.main(['download', '-d', download_dir, packagename])
    for file in os.listdir(download_dir):
        pkgname = get_packagename_from_filename(file)
        download_uri_for_file = resolve_download_url(pkgname, file)
        send_webservice_import_module_request(pkgname, download_uri_for_file)
        # Sleep a few seconds so we don't send too many import requests https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits#azure-automation-limits
        time.sleep(10)

if __name__ == '__main__':
    if len(sys.argv) < 11:
        raise Exception("Requires Subscription id -s, Automation resource group name -g, account name -a, module name -g and user-assigned managed identity client id -c as arguments. \
                        Example: -s xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx -g contosogroup -a contosoaccount -m pytz -c clientid")

    # Process any arguments sent in
    subscription_id = None
    resource_group = None
    automation_account = None
    module_name = None
    client_id_usi = None

    opts, args = getopt.getopt(sys.argv[1:], "s:g:a:m:c")
    for o, i in opts:
        if o == '-s':  
            subscription_id = i
        elif o == '-g':  
            resource_group = i
        elif o == '-a': 
            automation_account = i
        elif o == '-m': 
            module_name = i
        elif o == '-c': 
            client_id_usi = i

    # Set Run as token for this automation accounts service principal to be used to import the package into Automation account
    token = get_automation_usi_token()

    # Import package with dependencies from pypi.org
    import_package_with_dependencies(module_name)
    print ("\nCheck the python 3 packages page for import status...")

Mengimpor skrip ke dalam ruunbook

Untuk informasi tentang mengimpor runbook, lihat Mengimpor runbook dari portal Microsoft Azure. Salin file dari GitHub ke penyimpanan yang dapat diakses portal sebelum Anda menjalankan impor.

Halaman Impor runbook default nama runbook agar sesuai dengan nama skrip. Jika Anda memiliki akses ke bidang, Anda bisa mengubah nama. Tipe Runbook mungkin default ke Python 2.7. Jika ya, pastikan untuk mengubahnya menjadi Python 3.8.

Mengeksekusi runbook untuk mengimpor paket dan dependensi

Setelah membuat dan menerbitkan runbook, jalankan untuk mengimpor paket. Lihat Memulai runbook di Azure Automation untuk detail tentang mengeksekusi runbook.

Skrip (import_py3package_from_pypi.py) memerlukan parameter berikut.

Nilai parameter harus disediakan sebagai string tunggal dalam format di bawah ini:

-s <subscription_id> -g <resource_group> -a<automation_account> -m <module_name> -v <module_version>

Untuk informasi selengkapnya tentang menggunakan parameter dengan runbook, lihat Bekerja dengan parameter runbook.

Menggunakan paket dalam runbook

Dengan paket yang diimpor, Anda dapat menggunakannya dalam runbook. Tambahkan kode berikut untuk mencantumkan semua grup sumber daya dalam langganan Azure.

#!/usr/bin/env python3 
import os 
import requests  
# printing environment variables 
endPoint = os.getenv('IDENTITY_ENDPOINT')+"?resource=https://management.azure.com/" 
identityHeader = os.getenv('IDENTITY_HEADER') 
payload={} 
headers = { 
  'X-IDENTITY-HEADER': identityHeader,
  'Metadata': 'True' 
} 
response = requests.request("GET", endPoint, headers=headers, data=payload) 
print(response.text)

Mengidentifikasi paket yang tersedia di kotak pasir

Gunakan kode berikut untuk mencantumkan modul yang diinstal secara default:

#!/usr/bin/env python3

import pkg_resources
installed_packages = pkg_resources.working_set
installed_packages_list = sorted(["%s==%s" % (i.key, i.version)
   for i in installed_packages])

for package in installed_packages_list:
    print(package)

Cmdlet PowerShell Python 3.8

Tambahkan paket Python 3.8 baru

New-AzAutomationPython3Package -AutomationAccountName tarademo  -ResourceGroupName mahja -Name requires.io -ContentLinkUri https://files.pythonhosted.org/packages/7f/e2/85dfb9f7364cbd7a9213caea0e91fc948da3c912a2b222a3e43bc9cc6432/requires.io-0.2.6-py2.py3-none-any.whl 

Response  
ResourceGroupName     : mahja 
AutomationAccountName : tarademo 
Name                  : requires.io 
IsGlobal              : False 
Version               : 
SizeInBytes           : 0 
ActivityCount         : 0 
CreationTime          : 9/26/2022 1:37:13 PM +05:30 
LastModifiedTime      : 9/26/2022 1:37:13 PM +05:30 
ProvisioningState     : Creating 

Mencantumkan semua paket Python 3.8

Get-AzAutomationPython3Package -AutomationAccountName tarademo  -ResourceGroupName mahja 

Response : 
ResourceGroupName     : mahja 
AutomationAccountName : tarademo 
Name                  : cryptography 
IsGlobal              : False 
Version               : 
SizeInBytes           : 0 
ActivityCount         : 0 
CreationTime          : 9/26/2022 11:52:28 AM +05:30 
LastModifiedTime      : 9/26/2022 12:11:00 PM +05:30 
ProvisioningState     : Failed 
ResourceGroupName     : mahja 
AutomationAccountName : tarademo 
Name                  : requires.io 
IsGlobal              : False 
Version               : 
SizeInBytes           : 0 
ActivityCount         : 0 
CreationTime          : 9/26/2022 1:37:13 PM +05:30 
LastModifiedTime      : 9/26/2022 1:39:04 PM +05:30 
ProvisioningState     : ContentValidated 
ResourceGroupName     : mahja 
AutomationAccountName : tarademo 
Name                  : sockets 
IsGlobal              : False 
Version               : 1.0.0 
SizeInBytes           : 4495 
ActivityCount         : 0 
CreationTime          : 9/20/2022 12:46:28 PM +05:30 
LastModifiedTime      : 9/22/2022 5:03:42 PM +05:30 
ProvisioningState     : Succeeded 

Mendapatkan detail tentang paket tertentu

Get-AzAutomationPython3Package -AutomationAccountName tarademo  -ResourceGroupName mahja -Name sockets 


Response  
ResourceGroupName     : mahja 
AutomationAccountName : tarademo 
Name                  : sockets 
IsGlobal              : False 
Version               : 1.0.0 
SizeInBytes           : 4495 
ActivityCount         : 0 
CreationTime          : 9/20/2022 12:46:28 PM +05:30 
LastModifiedTime      : 9/22/2022 5:03:42 PM +05:30 
ProvisioningState     : Succeeded 

Hapus paket Python 3.8

Remove-AzAutomationPython3Package -AutomationAccountName tarademo  -ResourceGroupName mahja -Name sockets 

Memperbarui paket Python 3.8

Set-AzAutomationPython3Package -AutomationAccountName tarademo  -ResourceGroupName mahja -Name requires.io -ContentLinkUri https://files.pythonhosted.org/packages/7f/e2/85dfb9f7364cbd7a9213caea0e91fc948da3c912a2b222a3e43bc9cc6432/requires.io-0.2.6-py2.py3-none-any.whl 


ResourceGroupName     : mahja 
AutomationAccountName : tarademo 
Name                  : requires.io 
IsGlobal              : False 
Version               : 0.2.6 
SizeInBytes           : 10109 
ActivityCount         : 0 
CreationTime          : 9/26/2022 1:37:13 PM +05:30 
LastModifiedTime      : 9/26/2022 1:43:12 PM +05:30 
ProvisioningState     : Creating 

Langkah berikutnya

Untuk menyiapkan runbook Python, lihat Membuat runbook Python.