Python 3-pakketten beheren in Azure Automation

In dit artikel wordt beschreven hoe u Python 3-pakketten importeert, beheert en gebruikt in Azure Automation die wordt uitgevoerd in de Azure-sandboxomgeving en Hybrid Runbook Workers. Python-pakketten moeten worden gedownload op Hybrid Runbook Workers om taken succesvol te kunnen uitvoeren. Om runbooks te vereenvoudigen, kunt u Python-pakketten gebruiken om de modules te importeren die u nodig hebt.

Zie Python 2-pakketten beheren voor meer informatie over het beheren van Python 2-pakketten.

Standaard Python-pakketten

Ter ondersteuning van Python 3.8-runbooks in de Automation-service worden sommige Python-pakketten standaard geïnstalleerd en vindt u hier een lijst met deze pakketten. De standaardversie kan worden overschreven door Python-pakketten te importeren in uw Automation-account.

De voorkeur wordt gegeven aan de geïmporteerde versie in uw Automation-account. Zie Een pakket importeren als u één pakket wilt importeren. Als u een pakket met meerdere pakketten wilt importeren, raadpleegt u Een pakket importeren met afhankelijkheden.

Pakketten als bronbestanden

Azure Automation ondersteunt alleen een Python-pakket dat alleen Python-code bevat en geen andere taalextensies of code in andere talen bevat. De Azure Sandbox-omgeving heeft mogelijk echter niet de vereiste compilers voor binaire C/C++-bestanden, dus het is raadzaam om in plaats daarvan wheel-bestanden te gebruiken.

De Python Package Index (PyPI) is een opslagplaats met software voor de Python-programmeertaal. Wanneer u een Python 3-pakket selecteert dat u wilt importeren in uw Automation-account vanuit PyPI, moet u rekening houden met de volgende bestandsnamen:

Selecteer een Python-versie:

Een pakket importeren

1. Selecteer Python-pakketten onder Gedeelde resources in uw Automation-account. Selecteer vervolgens + Een Python-pakket toevoegen.

   

2. Selecteer op de pagina Python-pakket toevoegen een lokaal pakket om te uploaden. Het pakket kan een .whl- of .tar.gz-bestand voor Python 3.8 en een .whl-bestand voor Python 3.10 (preview) zijn.

3. Voer een naam in en selecteer de Runtime-versie als Python 3.8 of Python 3.10 (preview).

   Notitie

   Momenteel wordt runtimeversie van Python 3.10 (preview) ondersteund voor cloud- en hybride taken in alle openbare regio's, behalve Australië - centraal2, Korea - zuid, Zweden - zuid, Jio India - centraal, Brazilië - zuidoost, India - centraal, India - west, UAE - centraal en Gov-clouds.

4. Selecteer Importeren.

   

Nadat een pakket is geïmporteerd, wordt het weergegeven op de pagina Python-pakketten in uw Automation-account. Om een pakket te verwijderen, selecteert u het pakket en selecteert u Verwijderen.

Een pakket met afhankelijkheden importeren

U kunt een Python 3.8-pakket en de bijbehorende afhankelijkheden importeren door het volgende Python-script te importeren in een Python 3.8-runbook. Zorg ervoor dat Beheerde identiteit is ingeschakeld voor uw Automation-account en toegang als Automation-inzender heeft voor een geslaagde import van het pakket.

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 depeendencies
    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#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...")

Het script importeren in een runbook

Zie Een runbook importeren uit de Azure-portal voor meer informatie over het importeren van het runbook. Kopieer het bestand van GitHub naar de opslag waartoe de portal toegang heeft voordat u de import uitvoert.

Op de pagina Een runbook importeren wordt de naam van het runbook standaard aangepast aan de naam van het script. Als u toegang tot het veld hebt, kunt u de naam wijzigen. Runbooktype is mogelijk standaard ingesteld op Python 2.7. Als dit het geval is, moet u het wijzigen in Python 3.8.

Het runbook uitvoeren om het pakket en de afhankelijkheden te importeren

Nadat u het runbook hebt gemaakt en gepubliceerd, voert u het uit om het pakket te importeren. Zie Een runbook starten in Azure Automation voor meer informatie over het uitvoeren van het runbook.

Voor het script (import_py3package_from_pypi.py) zijn de volgende parameters vereist.

Parameterwaarde moet worden opgegeven als één tekenreeks in de onderstaande indeling:

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

Zie Werken met runbookparameters voor meer informatie over het gebruik van parameters met runbooks.

Een pakket gebruiken in een runbook

Als het pakket is geïmporteerd, kunt u het gebruiken in een runbook. Voeg de volgende code toe om alle resourcegroepen in een Azure-abonnement weer te geven.

#!/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)

Beschikbare pakketten identificeren in sandbox

Gebruik de volgende code om de standaard geïnstalleerde modules weer te geven:

#!/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)

Python 3.8 PowerShell-cmdlets

Nieuw Python 3.8-pakket toevoegen

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 

Alle Python 3.8-pakketten weergeven

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 

Details over een specifiek pakket verkrijgen

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 

Python 3.8-pakket verwijderen

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

Python 3.8-pakket bijwerken

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 

Volgende stappen

Zie Een Python-runbook maken om een Python-runbook voor te bereiden.