在 Azure 自动化中管理 Python 3 程序包

本文介绍如何在 Azure 自动化（在 Azure 沙盒环境和混合 Runbook 辅助角色上运行）中导入、管理和使用 Python 3 包。 要成功执行作业，应在混合 Runbook 辅助角色上下载 Python 包。 为了帮助简化 runbook，可以使用 Python 包导入所需的模块。

有关如何管理 Python 2 包的信息，请参阅管理 Python 2 包。

默认 Python 包

为了在自动化服务中支持 Python 3.8 runbook，默认安装了一些 Python 包，此处提供了这些包的列表。 通过在自动化帐户中导入 Python 包，可以替代默认版本。

优先考虑自动化帐户中已导入的版本。 若要导入单个包，请参阅导入包。 若要导入包含多个包的包，请参阅导入具有依赖项的包。

作为源文件的包

Azure 自动化仅支持 Python 包，该 Python 只包含 Python 代码，不包括其他语言的扩展或者用其他语言写成的代码。 然而，Azure 沙盒可能没有所需的 C/C++ 二进制文件编辑器，所以建议使用 wheel 文件。

Python 包索引 (PyPI) 是 Python 编程语言的软件存储库。 从 PyPI 中选择 Python 3 包导入自动化帐户时，请注意以下文件名部分：

选择 Python 版本：

Python 3.8（正式版）

例如：

• 若要导入 pandas - 选择名称类似于 pandas-1.2.3-cp38-win_amd64.whl 的 wheel 文件。

PyPI 上面的一些 Python 包不提供 wheel 文件。 在这种情况下，下载源文件（.zip 或者.tar.gz 文件）然后使用 pip 生成 wheel 文件。

使用装有 Python 3.8.x 和 wheel 包的 64 位 Windows 计算机执行以下步骤：

1. 下载源文件pandas-1.2.4.tar.gz。
2. 运行 pip，使用以下命令获取 wheel 文件：pip wheel --no-deps pandas-1.2.4.tar.gz

导入包

1. 在你的自动化帐户中，在“共享资源”下选择“Python 程序包”。 接下来，选择 + 添加 Python 包。

   

2. 在 添加 Python 包页中，选择要上传的本地包。 对于 Python 3.8，该包可以是 .whl 或 .tar.gz 文件。

3. 输入名称，并选择 Python 3.8 作为“运行时版本”。

4. 选择“导入” 。

   

导入包后，它会在自动化帐户中的“Python 包”页上列出。 若要删除某个包，请先选择该包，然后选择删除。

导入具有依赖项的包

可以导入 Python 3.8 包及其依赖项，方法是将以下 Python 脚本导入到 Python 3.8 runbook 中。 确保为自动化帐户启用了托管标识，并使托管标识具有“自动化参与者”访问权限，以便成功导入包。

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.chinacloudapi.cn/" 
    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.chinacloudapi.cn/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://learn.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...")

将脚本导入 runbook

有关导入 runbook 的信息，请参阅从 Azure 门户导入 runbook。 在运行导入之前，请将文件从 GitHub 复制到可供门户访问的存储中。

“导入 runbook”页默认将 runbook 名称设置为与脚本名称匹配。 如果有权访问该字段，则可以更改该名称。 Runbook 类型可能默认设置为 Python 2.7。 如果是这样，请确保将其更改为 Python 3.8。

执行 runbook 以导入包和依赖项

创建并发布 runbook 后，运行它来导入包。 若要详细了解如何执行 runbook，请参阅在 Azure 自动化中启动 runbook。

脚本 (import_py3package_from_pypi.py) 需要以下参数。

应按以下格式将参数值作为单个字符串提供：

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

若要详细了解如何在 runbook 中使用参数，请参阅使用 runbook 参数。

在 runbook 中使用包

导入程序包后，可以在 runbook 中使用它。 添加以下代码以列出 Azure 订阅中的所有资源组。

#!/usr/bin/env python3 
import os 
import requests  
# printing environment variables 
endPoint = os.getenv('IDENTITY_ENDPOINT')+"?resource=https://management.chinacloudapi.cn/" 
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)

确定沙盒中可用的包

使用以下代码列出默认已安装的模块：

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

添加新的 Python 3.8 包

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 

列出所有 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 

获取有关特定包的详细信息

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 包

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

更新 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 

后续步骤

要准备 Python runbook，请参阅创建 Python runbook。