AzureResourceManagerTemplateDeployment@3 - مهمة نشر قالب ARM v3

استخدم هذه المهمة لنشر قالب Azure Resource Manager (ARM) إلى جميع نطاقات التوزيع.

بناء الجملة

# ARM template deployment v3
# Deploy an Azure Resource Manager (ARM) template to all the deployment scopes.
- task: AzureResourceManagerTemplateDeployment@3
  inputs:
  # Azure Details
    deploymentScope: 'Resource Group' # 'Management Group' | 'Subscription' | 'Resource Group'. Required. Deployment scope. Default: Resource Group.
    azureResourceManagerConnection: # string. Alias: ConnectedServiceName. Required. Azure Resource Manager connection. 
    #subscriptionId: # string. Alias: subscriptionName. Required when deploymentScope != Management Group. Subscription. 
    #action: 'Create Or Update Resource Group' # 'Create Or Update Resource Group' | 'DeleteRG'. Required when deploymentScope = Resource Group. Action. Default: Create Or Update Resource Group.
    #resourceGroupName: # string. Required when deploymentScope = Resource Group. Resource group. 
    #location: # string. Required when action = Create Or Update Resource Group || deploymentScope != Resource Group. Location. 
  # Template
    #templateLocation: 'Linked artifact' # 'Linked artifact' | 'URL of the file'. Required when action = Create Or Update Resource Group || deploymentScope != Resource Group. Template location. Default: Linked artifact.
    #csmFileLink: # string. Required when templateLocation = URL of the file && action = Create Or Update Resource Group || deploymentScope != Resource Group. Template link. 
    #csmParametersFileLink: # string. Optional. Use when templateLocation = URL of the file && action = Create Or Update Resource Group || deploymentScope != Resource Group. Template parameters link. 
    #csmFile: # string. Required when templateLocation = Linked artifact && action = Create Or Update Resource Group || deploymentScope != Resource Group. Template. 
    #csmParametersFile: # string. Optional. Use when templateLocation = Linked artifact && action = Create Or Update Resource Group || deploymentScope != Resource Group. Template parameters. 
    #overrideParameters: # string. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Override template parameters. 
    #deploymentMode: 'Incremental' # 'Incremental' | 'Complete' | 'Validation'. Required when action = Create Or Update Resource Group || deploymentScope != Resource Group. Deployment mode. Default: Incremental.
  # Advanced
    #deploymentName: # string. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Deployment name. 
    #deploymentOutputs: # string. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Deployment outputs. 
    #addSpnToEnvironment: false # boolean. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Access service principal details in override parameters. Default: false.
    #useWithoutJSON: false # boolean. Optional. Use when action = Create Or Update Resource Group || deploymentScope != Resource Group. Use individual output values without JSON.Stringify applied. Default: false.

الإدخالات

deploymentScope - نطاق التوزيع
string. مطلوب القيم المسموح بها: Management Group، ، Subscription. Resource Group القيمة الافتراضية: Resource Group.

نطاق التوزيع. تعرف على المزيد حول نطاقات التوزيع.

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

يحدد اتصال خدمة Azure Resource Manager مع الوصول إلى نطاق النشر المحدد.

subscriptionId - الاشتراك
الاسم المستعار للإدخل: subscriptionName. string. مطلوب عند deploymentScope != Management Group.

يحدد اشتراك Azure.

هام

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

action - العمل
string. مطلوب عند deploymentScope = Resource Group. القيم المسموح بها: Create Or Update Resource Group، DeleteRG (حذف مجموعة الموارد). القيمة الافتراضية: Create Or Update Resource Group.

الإجراء الذي سيتم تنفيذه على موارد Azure أو مجموعة الموارد.

resourceGroupName - مجموعة الموارد
string. مطلوب عند deploymentScope = Resource Group.

يوفر اسم مجموعة موارد.

location - موقع
string. مطلوب عند action = Create Or Update Resource Group || deploymentScope != Resource Group.

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

templateLocation - موقع القالب
string. مطلوب عند action = Create Or Update Resource Group || deploymentScope != Resource Group. القيم المسموح بها: Linked artifact، . URL of the file القيمة الافتراضية: Linked artifact.

موقع القالب وملفات JSON للمعلمات. اختر البيانات الاصطناعية المرتبطة إذا كانت الملفات جزءا من التعليمات البرمجية المرتبطة/البيانات الاصطناعية للبناء. بالنسبة للبيانات الاصطناعية المرتبطة، يمكنك أيضا تحديد المسار إلى ملف Bicep. اختر عنوان URL للملف إذا كانت ملفات JSON موجودة في أي عناوين URL http/https يمكن الوصول إليها بشكل عام. لاستخدام ملف مخزن في حساب تخزين خاص، قم باسترداد وتضمين الرمز المميز لتوقيع الوصول المشترك (SAS) في عنوان URL للقالب. مثال:<blob_storage_url>/template.json?. لتحميل ملف معلمات إلى حساب تخزين وإنشاء رمز SAS مميز، يمكنك استخدام مهمة نسخ ملف Azure أو اتباع الخطوات باستخدام PowerShell أو Azure CLI.

csmFileLink - ارتباط القالب
string. مطلوب عند templateLocation = URL of the file && action = Create Or Update Resource Group || deploymentScope != Resource Group.

يحدد عنوان URL لملف القالب. مثال على URL: https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-vm-simple-windows/azuredeploy.json

لنشر قالب مخزن في حساب تخزين خاص، قم باسترداد وتضمين الرمز المميز لتوقيع الوصول المشترك (SAS) في عنوان URL للقالب. مثال:<blob_storage_url>/template.json?<SAStoken>. لتحميل ملف قالب (أو قالب مرتبط) إلى حساب تخزين وإنشاء رمز SAS مميز، استخدم مهمة نسخ ملف Azure أو اتبع الخطوات باستخدام PowerShell أو Azure CLI.

لعرض معلمات القالب في شبكة، انقر فوق ... بجوار مربع النص تجاوز معلمات القالب. تتطلب هذه الميزة تمكين قواعد CORS في المصدر. إذا كانت القوالب في كائن ثنائي كبير الحجم لتخزين Azure، فراجع مشاركة الموارد عبر المنشأ لتمكين CORS.

csmParametersFileLink - ارتباط معلمات القالب
string. ‏‏اختياري. استخدم عندما templateLocation = URL of the file && action = Create Or Update Resource Group || deploymentScope != Resource Group.

يحدد عنوان URL لملف المعلمات. مثال على URL: https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/101-vm-simple-windows/azuredeploy.parameters.json

لاستخدام ملف مخزن في حساب تخزين خاص، قم باسترداد وتضمين الرمز المميز لتوقيع الوصول المشترك (SAS) في عنوان URL للقالب. مثال:<blob_storage_url>/template.json?<SAStoken>. لتحميل ملف قالب (أو قالب مرتبط) إلى حساب تخزين وإنشاء رمز SAS مميز، استخدم مهمة نسخ ملف Azure أو اتبع الخطوات باستخدام PowerShell أو Azure CLI.

لعرض معلمات القالب في شبكة، انقر فوق ... بجوار مربع النص تجاوز معلمات القالب. تتطلب هذه الميزة تمكين قواعد CORS في المصدر. إذا كانت القوالب في كائن ثنائي كبير الحجم لتخزين Azure، فراجع مشاركة الموارد عبر المنشأ لتمكين CORS.

csmFile - قالب
string. مطلوب عند templateLocation = Linked artifact && action = Create Or Update Resource Group || deploymentScope != Resource Group.

يحدد المسار أو النمط الذي يشير إلى قالب Azure Resource Manager. تعرف على المزيد حول قوالب Azure Resource Manager. للبدء على الفور، استخدم نموذج القالب هذا. يدعم ملفات Bicep عند إصدار > Azure CLI 2.20.0.

csmParametersFile - معلمات القالب
string. ‏‏اختياري. استخدم عندما templateLocation = Linked artifact && action = Create Or Update Resource Group || deploymentScope != Resource Group.

حدد المسار أو نمط يشير إلى ملف المعلمات لقالب Azure Resource Manager. يدعم ملفات Bicep Param عند إصدار > Azure CLI 2.47.0.

overrideParameters - تجاوز معلمات القالب
string. ‏‏اختياري. استخدم عندما action = Create Or Update Resource Group || deploymentScope != Resource Group.

تحديد معلمات القالب لتجاوزها.

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

مثال:-storageName fabrikam -adminUsername $(vmusername) -adminPassword (ConvertTo-SecureString -String '$(password)' -AsPlainText -Force) -azureKeyVaultName $(fabrikamFibre).

إذا كانت قيمة المعلمة تحتوي على كلمات متعددة، فقم بإحاطة الكلمات بعلامات اقتباس، حتى إذا كنت تمرر القيمة باستخدام المتغيرات. على سبيل المثال، ⁧-name "parameter value" -name2 "$(var)"⁩. لتجاوز معلمات نوع الكائن، استخدم كائنات JSON سلسلة. على سبيل المثال، ⁧-options ["option1"] -map {"key1": "value1" }⁩.

deploymentMode - وضع التوزيع
string. مطلوب عند action = Create Or Update Resource Group || deploymentScope != Resource Group. القيم المسموح بها: Incremental، Complete، Validation (التحقق فقط). القيمة الافتراضية: Incremental.

Incremental يعالج الوضع عمليات التوزيع كتحديثات تزايدية لمجموعة الموارد. يترك الموارد التي لم تتغير الموجودة في مجموعة الموارد ولكن لم يتم تحديدها في القالب.

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

تحذير

سيقوم الوضع الكامل بحذف كافة الموارد الموجودة في مجموعة الموارد غير المحددة في القالب. راجع ما إذا كانت مجموعة الموارد التي تقوم بنشرها لا تحتوي على أي موارد ضرورية لم يتم تحديدها في القالب. Validate يمكنك الوضع من العثور على مشكلات في القالب قبل إنشاء الموارد الفعلية.

ملاحظة

Validate يقوم الوضع دائما بإنشاء مجموعة موارد، حتى إذا لم يتم نشر أي موارد. تعرف على المزيد حول أوضاع التوزيع.

deploymentName - اسم التوزيع
string. ‏‏اختياري. استخدم عندما action = Create Or Update Resource Group || deploymentScope != Resource Group.

يحدد اسم توزيع مجموعة الموارد المراد إنشاؤه.

deploymentOutputs - مخرجات التوزيع
string. ‏‏اختياري. استخدم عندما action = Create Or Update Resource Group || deploymentScope != Resource Group.

يوفر اسما للمتغير لمتغير الإخراج، والذي يحتوي على قسم المخرجات لعنصر التوزيع الحالي بتنسيق السلسلة. يمكنك استخدام ConvertFrom-Json PowerShell cmdlet لتحليل كائن JSON والوصول إلى قيم الإخراج الفردية. تعرف على المزيد حول مخرجات التوزيع.

addSpnToEnvironment - الوصول إلى تفاصيل كيان الخدمة في تجاوز المعلمات
boolean. ‏‏اختياري. استخدم عندما action = Create Or Update Resource Group || deploymentScope != Resource Group. القيمة الافتراضية: false.

يضيف معرف كيان الخدمة ومفتاح نقطة نهاية Azure التي تم اختيارها لتكون بيئة تنفيذ البرنامج النصي. يمكن أن تكون المتغيرات $servicePrincipalId و $servicePrincipalKey في معلمات التجاوز، مثل -key $servicePrincipalKey.

useWithoutJSON - استخدم قيم الإخراج الفردية بدون JSON. تم تطبيق Stringify
boolean. ‏‏اختياري. استخدم عندما action = Create Or Update Resource Group || deploymentScope != Resource Group. القيمة الافتراضية: false.

يتم تحويل قيم الإخراج الفردية عبر JSON. Stringify بشكل افتراضي. إذا كنت تريد استخدام قيم الإخراج كما هي دون تحويلها عبر JSON. Stringify، قم بتمكين هذا الخيار. لمزيد من التفاصيل، راجع هذا.

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

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

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

لا شيء

الملاحظات

ملاحظة

تدعم هذه المهمة ملفات Bicep عند إصدار > Azure CLI 2.20.0.

• دعم إضافي للتوزيع في جميع نطاقات التوزيع.
  • إزالة جميع الإجراءات المتعلقة بالجهاز الظاهري.

المتطلبات

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