AzureCLI@2 - مهمة Azure CLI v2

قم بتشغيل أوامر Azure CLI مقابل اشتراك Azure في برنامج نصي PowerShell Core/shell عند التشغيل على عامل Linux. أو قم بتشغيل أوامر Azure CLI مقابل اشتراك Azure في برنامج نصي PowerShell/PowerShell Core/batch عند التشغيل على عامل Windows.

قم بتشغيل أوامر Azure CLI مقابل اشتراك Azure في برنامج نصي PowerShell Core/shell عند التشغيل على عامل Linux. أو قم بتشغيل أوامر Azure CLI مقابل اشتراك Azure في برنامج نصي PowerShell/Powershell Core/batch عند التشغيل على عامل Windows.

بناء الجملة

# Azure CLI v2
# Run Azure CLI commands against an Azure subscription in a PowerShell Core/Shell script when running on Linux agent or PowerShell/PowerShell Core/Batch script when running on Windows agent.
- task: AzureCLI@2
  inputs:
    azureSubscription: # string. Alias: connectedServiceNameARM. Required. Azure Resource Manager connection. 
    scriptType: # 'ps' | 'pscore' | 'batch' | 'bash'. Required. Script Type. 
    scriptLocation: 'scriptPath' # 'inlineScript' | 'scriptPath'. Required. Script Location. Default: scriptPath.
    scriptPath: # string. Required when scriptLocation = scriptPath. Script Path. 
    #inlineScript: # string. Required when scriptLocation = inlineScript. Inline Script. 
    #arguments: # string. Alias: scriptArguments. Script Arguments. 
    #powerShellErrorActionPreference: 'stop' # 'stop' | 'continue' | 'silentlyContinue'. Optional. Use when scriptType = ps || scriptType = pscore. ErrorActionPreference. Default: stop.
  # Advanced
    #addSpnToEnvironment: false # boolean. Access service principal details in script. Default: false.
    #useGlobalConfig: false # boolean. Use global Azure CLI configuration. Default: false.
    #workingDirectory: # string. Alias: cwd. Working Directory. 
    #failOnStandardError: false # boolean. Fail on Standard Error. Default: false.
    #powerShellIgnoreLASTEXITCODE: false # boolean. Optional. Use when scriptType = ps || scriptType = pscore. Ignore $LASTEXITCODE. Default: false.
# Azure CLI v2
# Run Azure CLI commands against an Azure subscription in a PowerShell Core/Shell script when running on Linux agent or PowerShell/Powershell Core/Batch script when running on Windows agent.
- task: AzureCLI@2
  inputs:
    azureSubscription: # string. Alias: connectedServiceNameARM. Required. Azure Resource Manager connection. 
    scriptType: # 'ps' | 'pscore' | 'batch' | 'bash'. Required. Script Type. 
    scriptLocation: 'scriptPath' # 'inlineScript' | 'scriptPath'. Required. Script Location. Default: scriptPath.
    scriptPath: # string. Required when scriptLocation = scriptPath. Script Path. 
    #inlineScript: # string. Required when scriptLocation = inlineScript. Inline Script. 
    #arguments: # string. Alias: scriptArguments. Script Arguments. 
    #powerShellErrorActionPreference: 'stop' # 'stop' | 'continue' | 'silentlyContinue'. Optional. Use when scriptType = ps || scriptType = pscore. ErrorActionPreference. Default: stop.
  # Advanced
    #addSpnToEnvironment: false # boolean. Access service principal details in script. Default: false.
    #useGlobalConfig: false # boolean. Use global Azure CLI configuration. Default: false.
    #workingDirectory: # string. Alias: cwd. Working Directory. 
    #failOnStandardError: false # boolean. Fail on Standard Error. Default: false.
    #powerShellIgnoreLASTEXITCODE: false # boolean. Optional. Use when scriptType = ps || scriptType = pscore. Ignore $LASTEXITCODE. Default: false.

الإدخالات

azureSubscription - اتصال Azure Resource Manager
الاسم المستعار للإدخل: connectedServiceNameARM. string. مطلوب

حدد اتصال خدمة Azure Resource Manager للتوزيع.


scriptType - نوع البرنامج النصي
string. مطلوب القيم المسموح بها: ps (PowerShell)، pscore (PowerShell Core)، batch، bash (Shell).

نوع البرنامج النصي. حدد برنامج نصي أو bashpscore عند التشغيل على عامل Linux. أو حدد أو batchpsأو pscore برنامج نصي عند التشغيل على عامل Windows. pscore يمكن تشغيل البرنامج النصي على وكلاء عبر الأنظمة الأساسية (Linux أو macOS أو Windows).


scriptType - نوع البرنامج النصي
string. مطلوب القيم المسموح بها: ps (Powershell)، pscore (Powershell Core)، batch، bash (Shell).

نوع البرنامج النصي. حدد برنامج نصي أو bashpscore عند التشغيل على عامل Linux. أو حدد أو batchpsأو pscore برنامج نصي عند التشغيل على عامل Windows. pscore يمكن تشغيل البرنامج النصي على وكلاء عبر الأنظمة الأساسية (Linux أو macOS أو Windows).


scriptLocation - موقع البرنامج النصي
string. مطلوب القيم المسموح بها: inlineScript (البرنامج النصي المضمن)، scriptPath (مسار البرنامج النصي). القيمة الافتراضية: scriptPath.

المسار إلى البرنامج النصي.


scriptPath - مسار البرنامج النصي
string. مطلوب عند scriptLocation = scriptPath.

مسار مؤهل بالكامل للبرنامج النصي. استخدم .ps1أو .batأو .cmd عند استخدام عامل مستند إلى Windows. استخدم .ps1 أو .sh عند استخدام عامل يستند إلى Linux أو مسارا يتعلق بدليل العمل الافتراضي.


inlineScript - البرنامج النصي المضمن
string. مطلوب عند scriptLocation = inlineScript.

يمكنك كتابة البرامج النصية الخاصة بك مضمنة هنا. عند استخدام عامل Windows، استخدم PowerShell أو PowerShell Core أو البرمجة النصية الدفعية. استخدم البرمجة النصية PowerShell Core أو shell عند استخدام عوامل تستند إلى Linux. بالنسبة للملفات الدفعية، استخدم البادئة call قبل كل أمر Azure. يمكنك أيضا تمرير متغيرات معرفة مسبقا ومخصصة إلى هذا البرنامج النصي باستخدام الوسيطات.

فيما يلي مثال على PowerShell/PowerShellCore/shell.

az --version 
az account show 

فيما يلي مثال على الدفعة.

call  az --version 
call az account show

arguments - وسيطات البرنامج النصي
الاسم المستعار للإدخل: scriptArguments. string.

تم تمرير الوسيطات إلى البرنامج النصي.


powerShellErrorActionPreference - ErrorActionPreference
string. ‏‏اختياري. استخدم عندما scriptType = ps || scriptType = pscore. القيم المسموح بها: stop، ، continuesilentlyContinue. القيمة الافتراضية: stop.

إلحاق السطر $ErrorActionPreference = 'VALUE' في أعلى البرنامج النصي PowerShell/PowerShell Core.


addSpnToEnvironment - الوصول إلى تفاصيل كيان الخدمة في البرنامج النصي
boolean. القيمة الافتراضية: false.

يضيف معرف كيان الخدمة أو مفتاح كيان الخدمة أو رمز اتحاد هوية حمل العمل ومعرف المستأجر لنقطة نهاية Azure التي اخترتها إلى بيئة تنفيذ البرنامج النصي. يمكنك استخدام servicePrincipalIdالمتغيرات أو servicePrincipalKey و idTokenفي tenantId البرنامج النصي الخاص بك.

يتم احترام هذا فقط عندما تحتوي نقطة نهاية Azure على نظام مصادقة كيان الخدمة أو نظام مصادقة اتحاد هوية حمل العمل.

تعرض القائمة التالية بناء الجملة للوصول إلى متغيرات البيئة استنادا إلى نوع البرنامج النصي.

  • بناء جملة البرنامج النصي PowerShell: $env:servicePrincipalId

  • بناء جملة البرنامج النصي الدفعي: %servicePrincipalId%

  • بناء جملة البرنامج النصي Shell: $servicePrincipalId


useGlobalConfig - استخدام تكوين Azure CLI العمومي
boolean. القيمة الافتراضية: false.

إذا كان هذا الإدخال خاطئا، فستستخدم هذه المهمة دليل تكوين Azure CLI الخاص بها. استخدم هذه المهمة لتشغيل مهام Azure CLI في الإصدارات المتوازية .


workingDirectory - دليل العمل
الاسم المستعار للإدخل: cwd. string.

دليل العمل الحالي حيث يتم تشغيل البرنامج النصي. إذا ترك فارغا، فإن هذا الإدخال هو جذر المستودع (الإنشاء) أو البيانات الاصطناعية (الإصدار)، وهو $(System.DefaultWorkingDirectory).


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

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


powerShellIgnoreLASTEXITCODE - تجاهل $LASTEXITCODE
boolean. ‏‏اختياري. استخدم عندما scriptType = ps || scriptType = pscore. القيمة الافتراضية: false.

إذا كان هذا الإدخال خاطئا، يتم إلحاق السطر if ((Test-Path -LiteralPath variable:\LASTEXITCODE)) { exit $LASTEXITCODE } بنهاية البرنامج النصي الخاص بك. سيؤدي ذلك إلى نشر التعليمة البرمجية للخروج الأخير من أمر خارجي كتعلم برمجي للخروج من PowerShell. وإلا، لا يتم إلحاق السطر بنهاية البرنامج النصي الخاص بك.


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

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

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

لا شيء

الملاحظات

ما الجديد في الإصدار 2.0 من إصدار المهمة

  • دعم البرنامج النصي PowerShell وPowerShell Core.
  • يعمل PowerShell Core مع وكلاء عبر الأنظمة الأساسية (Linux أو macOS أو Windows)، تأكد من أن العامل لديه الإصدار 6 أو أكثر من PowerShell.
  • يعمل برنامج Powershell النصي مع عامل Windows فقط، وتأكد من أن العامل لديه الإصدار 5 أو أقل من PowerShell.

المتطلبات الأساسية

  • اشتراك في Microsoft Azure.
  • اتصال خدمة Azure Resource Manager بحساب Azure الخاص بك.
  • وكلاء Microsoft المستضافون لديهم Azure CLI مثبت مسبقًا. ومع ذلك، إذا كنت تستخدم وكلاء خاصين، فقم بتثبيت Azure CLI على أجهزة الكمبيوتر التي تقوم بتشغيل وكيل الإنشاء والإصدار. إذا كان هناك وكيل يعمل بالفعل على الجهاز الذي تم تثبيت Azure CLI عليه، فأعد تشغيل الوكيل لضمان تحديث جميع متغيرات المرحلة ذات الصلة.

أمثلة

يسرد المثال التالي إصدار Azure CLI ويحصل على تفاصيل الاشتراك.

- task: AzureCLI@2
  displayName: Azure CLI
  inputs:
    azureSubscription: <Name of the Azure Resource Manager service connection>
    scriptType: ps
    scriptLocation: inlineScript
    inlineScript: |
      az --version
      az account show

يوضح المثال التالي كيفية تمرير الوسيطات إلى البرنامج النصي الخاص بك.

  • تمرير الوسيطات إلى البرامج النصية المضمنة:

    - task: AzureCLI@2
      inputs:
        azureSubscription: <Azure_Resource_Manager_Service_Connection>
        scriptType: 'ps'
        scriptLocation: 'inlineScript'
        arguments: '$(AZURE_STORAGE_ACCOUNT) $(AZURE_STORAGE_KEY)'
        inlineScript: './scripts/publish.ps1 $1 $2'
    
  • تمرير الوسيطات مع مسار البرنامج النصي:

    - task: AzureCLI@2
      inputs:
        azureSubscription: <Azure_Resource_Manager_Service_Connection>
        scriptType: 'ps'
        scriptLocation: 'scriptPath'
        arguments: '$(AZURE_STORAGE_ACCOUNT) $(AZURE_STORAGE_KEY)'
        scriptPath: './scripts/publish.ps1'
    

المتطلبات

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

راجع أيضًا