AzurePowerShell@5 - مهمة Azure PowerShell v5

استخدم هذه المهمة لتشغيل برنامج نصي PowerShell داخل بيئة Azure. تتم مصادقة سياق Azure مع اتصال خدمة Azure Resource Manager المتوفر.

ملاحظة

بشكل افتراضي، يستخدم Azure PowerShell v5 PowerShell Core لوكلاء Linux Windows PowerShell لوكلاء Windows. لاستخدام أحدث إصدار من PowerShell على وكلاء Windows، قم بتعيين المعلمة pwsh إلى true. سيتم بعد ذلك استخدام PowerShell Core بدلا من ذلك.

بناء الجملة

# Azure PowerShell v5
# Run a PowerShell script within an Azure environment.
- task: AzurePowerShell@5
  inputs:
    azureSubscription: # string. Alias: ConnectedServiceNameARM. Required. Azure Subscription. 
    #ScriptType: 'FilePath' # 'FilePath' | 'InlineScript'. Script Type. Default: FilePath.
    #ScriptPath: # string. Optional. Use when ScriptType = FilePath. Script Path. 
    #Inline: # string. Optional. Use when ScriptType = InlineScript. Inline Script. 
    #ScriptArguments: # string. Optional. Use when ScriptType = FilePath. Script Arguments. 
    #errorActionPreference: 'stop' # 'stop' | 'continue' | 'silentlyContinue'. ErrorActionPreference. Default: stop.
    #FailOnStandardError: false # boolean. Fail on Standard Error. Default: false.
  # Azure PowerShell version options
    #azurePowerShellVersion: 'OtherVersion' # 'LatestVersion' | 'OtherVersion'. Alias: TargetAzurePs. Azure PowerShell Version. Default: OtherVersion.
    preferredAzurePowerShellVersion: # string. Alias: CustomTargetAzurePs. Required when TargetAzurePs = OtherVersion. Preferred Azure PowerShell Version. 
  # Advanced
    #pwsh: false # boolean. Use PowerShell Core. Default: false.
    #validateScriptSignature: false # boolean. Optional. Use when ScriptType = FilePath. Validate script signature. Default: false.
    #workingDirectory: # string. Working Directory.
# Azure PowerShell v5
# Run a PowerShell script within an Azure environment.
- task: AzurePowerShell@5
  inputs:
    azureSubscription: # string. Alias: ConnectedServiceNameARM. Required. Azure Subscription. 
    #ScriptType: 'FilePath' # 'FilePath' | 'InlineScript'. Script Type. Default: FilePath.
    #ScriptPath: # string. Optional. Use when ScriptType = FilePath. Script Path. 
    #Inline: # string. Optional. Use when ScriptType = InlineScript. Inline Script. 
    #ScriptArguments: # string. Optional. Use when ScriptType = FilePath. Script Arguments. 
    #errorActionPreference: 'stop' # 'stop' | 'continue' | 'silentlyContinue'. ErrorActionPreference. Default: stop.
    #FailOnStandardError: false # boolean. Fail on Standard Error. Default: false.
  # Azure PowerShell version options
    #azurePowerShellVersion: 'OtherVersion' # 'LatestVersion' | 'OtherVersion'. Alias: TargetAzurePs. Azure PowerShell Version. Default: OtherVersion.
    preferredAzurePowerShellVersion: # string. Alias: CustomTargetAzurePs. Required when TargetAzurePs = OtherVersion. Preferred Azure PowerShell Version. 
  # Advanced
    #pwsh: false # boolean. Use PowerShell Core. Default: false.
    #workingDirectory: # string. Working Directory.

الإدخالات

azureSubscription - اشتراك Azure
الاسم المستعار للإدخل: ConnectedServiceNameARM. string. مطلوب

اشتراك Azure Resource Manager للتكوين قبل تشغيل PowerShell.


ScriptType - نوع البرنامج النصي
string. القيم المسموح بها: FilePath (مسار ملف البرنامج النصي)، InlineScript (البرنامج النصي المضمن). القيمة الافتراضية: FilePath.

نوع البرنامج النصي: مسار الملف أو المضمن.


ScriptPath - مسار البرنامج النصي
string. ‏‏اختياري. استخدم عندما ScriptType = FilePath.

مسار البرنامج النصي. يجب أن يكون هذا مسارا مؤهلا بالكامل أو مسارا واحدا بالنسبة إلى دليل العمل الافتراضي.


Inline - البرنامج النصي المضمن
string. ‏‏اختياري. استخدم عندما ScriptType = InlineScript. القيمة الافتراضية: # You can write your azure powershell scripts inline here. \n# You can also pass predefined and custom variables to this script using arguments.

مواصفات البرنامج النصي لتنفيذه. الحد الأقصى لطول البرنامج النصي المضمن المدعوم هو 5000 حرف. استخدم برنامج نصي من ملف إذا كنت تريد استخدام برنامج نصي أطول.


ScriptArguments - وسيطات البرنامج النصي
string. ‏‏اختياري. استخدم عندما ScriptType = FilePath.

المعلمات الإضافية لتمريرها إلى PowerShell. يمكن أن تكون هذه إما معلمات ترتيبية أو مسماة. لا ينطبق على خيار برنامج نصي مضمن.


errorActionPreference - ErrorActionPreference
string. القيم المسموح بها: stop، ، continuesilentlyContinue. القيمة الافتراضية: stop.

تحديد قيمة ErrorActionPreference المتغير لتنفيذ البرنامج النصي.


FailOnStandardError - فشل عند الخطأ القياسي
boolean. القيمة الافتراضية: false.

عندما يكون هذا صحيحا، ستفشل هذه المهمة إذا تمت كتابة أي أخطاء في مسار الخطأ أو إذا تمت كتابة أي بيانات إلى دفق الخطأ القياسي.


azurePowerShellVersion - إصدار Azure PowerShell
الاسم المستعار للإدخل: TargetAzurePs. string. القيم المسموح بها: LatestVersion (أحدث إصدار مثبت)، OtherVersion (تحديد إصدار آخر). القيمة الافتراضية: OtherVersion.

في حالة الوكلاء المستضافين، تكون إصدارات Azure PowerShell المدعومة هي 1.0.0و 2.3.21.6.02.6.0و و و 3.1.0 (قائمة انتظار VS2017 المستضافة). لاختيار أحدث إصدار متوفر على العامل، حدد LatestVersion (أحدث إصدار مثبت).

بالنسبة للوكلاء الخاصين، يمكنك تحديد إصدار مفضل من Azure PowerShell باستخدام OtherVersion (تحديد إصدار آخر).


preferredAzurePowerShellVersion - إصدار Azure PowerShell المفضل
الاسم المستعار للإدخل: CustomTargetAzurePs. string. مطلوب عند TargetAzurePs = OtherVersion.

يجب أن يكون إصدار Azure PowerShell المفضل إصدارا دلاليا مناسبا على سبيل المثال. 1.2.3. Regex like 2.\*,2.3.\* غير مدعوم. يدعم تجمع VS2017 المستضاف حاليا إصدارات الوحدة النمطية 1.0.0Az و 2.6.01.6.02.3.2و3.1.0.


pwsh - استخدام PowerShell Core
boolean. القيمة الافتراضية: false.

إذا كان هذا صحيحا، فستستخدم pwsh.exe المهام التي تعمل على وكلاء Windows من المسار بدلا من powershell.exe.


validateScriptSignature - التحقق من صحة توقيع البرنامج النصي
boolean. ‏‏اختياري. استخدم عندما ScriptType = FilePath. القيمة الافتراضية: false.

إذا كان هذا صحيحا، فستتحقق المهمة أولا للتأكد من توقيع البرنامج النصي المحدد وصالح قبل تنفيذه.


workingDirectory - دليل العمل
string.

دليل العمل حيث يتم تشغيل البرنامج النصي.


خيارات التحكم بالمهمة

تحتوي جميع المهام على خيارات التحكم بالإضافة إلى مدخلات المهام الخاصة بها. لمزيد من المعلومات، راجع خيارات التحكم وخصائص المهمة الشائعة.

متغيرات الإخراج

لا شيء

الملاحظات

استكشاف الأخطاء وإصلاحها

عمل البرنامج النصي محليا، ولكنه فشل في البنية الأساسية لبرنامج ربط العمليات التجارية

يحدث هذا عادة عندما يكون اتصال الخدمة المستخدم في البنية الأساسية لبرنامج ربط العمليات التجارية ليس لديه أذونات كافية لتشغيل البرنامج النصي. محليا، يتم تشغيل البرنامج النصي باستخدام بيانات الاعتماد الخاصة بك وسينجح حيث قد يكون لديك الوصول المطلوب.

لحل هذه المشكلة، تأكد من أن مبدأ الخدمة/ بيانات اعتماد المصادقة لها الأذونات المطلوبة. لمزيد من المعلومات، راجع استخدام Role-Based التحكم في الوصول لإدارة الوصول إلى موارد اشتراك Azure.

خطأ: تعذر العثور على الوحدات النمطية: "<اسم> الوحدة النمطية" مع الإصدار: "<الإصدار>". إذا تم تثبيت الوحدة النمطية مؤخرا، فقم بإعادة المحاولة بعد إعادة تشغيل عامل مهمة Azure Pipelines

تستخدم مهمة Azure PowerShell وحدة Azure/AzureRM/Az PowerShell للتفاعل مع اشتراك Azure. تحدث هذه المشكلة عندما لا تتوفر وحدة PowerShell النمطية على "العامل المستضاف". ومن ثم، بالنسبة لإصدار مهمة معين، يجب تحديد إصدار Azure PowerShell المفضل في خيارات إصدار Azure PowerShell من قائمة الإصدارات المتوفرة. يمكن العثور على البرنامج المثبت في جدول البرامج في العوامل المستضافة من Microsoft.

مشكلات اتصال الخدمة

لاستكشاف المشكلات المتعلقة باتصالات الخدمة وإصلاحها، راجع استكشاف أخطاء اتصال الخدمة وإصلاحها.

أمثلة

يوضح المثال التالي كيفية استدعاء برنامج نصي من ملف وتمرير وسيطات البرنامج النصي إليه.

- task: AzurePowerShell@5
  inputs:
    azureSubscription: my-arm-service-connection
    scriptType: filePath
    scriptPath: $(Build.SourcesDirectory)\myscript.ps1
    scriptArguments:
      -Arg1 val1 `
      -Arg2 val2 `
      -Arg3 val3
    azurePowerShellVersion: latestVersion
    pwsh: true

توضح الوسيطات التالية كيفية استدعاء برنامج نصي مضمن.

- task: AzurePowerShell@5
  inputs:
    azureSubscription: 'Azure subscription connection placeholder'
    azurePowerShellVersion: LatestVersion
    ScriptType: 'InlineScript'
    Inline: |
      # You can write your azure powershell scripts inline here. 
      # You can also pass predefined and custom variables to this script using arguments
      Write-Host 'Hello'
      Write-Host 'World!'

المتطلبات

المتطلبات الوصف
أنواع البنية الأساسية لبرنامج ربط العمليات التجارية YAML، الإصدار الكلاسيكي، الإصدار الكلاسيكي
يعمل على Agent, DeploymentGroup
المطالب بلا
القدرات لا تفي هذه المهمة بأي طلبات للمهام اللاحقة في الوظيفة.
قيود الأوامر أي
متغيرات Settable أي
إصدار الوكيل 2.115.0 أو أحدث
فئة المهمة نشر