@azure/arm-imagebuilder package

الفصول

ImageBuilderClient

الواجهات

DataDisk

خصائص قرص البيانات.

DistributeVersioner

توضح هذه المقالة كيفية إنشاء رقم إصدار x.y.z جديد للتوزيع.

DistributeVersionerLatest

إنشاء رقم الإصدار الذي سيكون الأحدث استنادا إلى أرقام الإصدارات الموجودة.

DistributeVersionerSource

إنشاء رقم الإصدار استنادا إلى رقم إصدار الصورة المصدر

ErrorAdditionalInfo

خطأ إدارة الموارد معلومات إضافية.

ErrorDetail

تفاصيل الخطأ.

ErrorResponse

استجابة الخطأ الشائعة لجميع واجهات برمجة تطبيقات Azure Resource Manager لإرجاع تفاصيل الخطأ للعمليات الفاشلة.

ImageBuilderClientOptionalParams

معلمات اختيارية للعميل.

ImageTemplate

قالب الصورة هو مورد ARM يديره موفر Microsoft.VirtualMachineImages

ImageTemplateAutoRun

يشير إلى ما إذا كان قالب الصورة يحتاج إلى الإنشاء/التحديث

ImageTemplateCustomizer

توضح هذه المقالة وحدة تخصيص الصورة

ImageTemplateDistributor

كائن توزيع عام

ImageTemplateFileCustomizer

تحميل الملفات إلى الأجهزة الظاهرية (Linux، Windows). يتوافق مع توفير ملف Packer

ImageTemplateFileValidator

تحميل الملفات المطلوبة للتحقق من الصحة إلى الأجهزة الظاهرية (Linux وWindows). يتوافق مع توفير ملف Packer

ImageTemplateIdentity

هوية قالب الصورة.

ImageTemplateInVMValidator

توضح هذه المقالة وحدة التحقق من صحة in-VM للصورة

ImageTemplateLastRunStatus

توضح هذه المقالة أحدث حالة لتشغيل قالب صورة

ImageTemplateManagedImageDistributor

توزيع كصورة قرص مدارة.

ImageTemplateManagedImageSource

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

ImageTemplatePlatformImageSource

يصف مصدر صورة من Azure Gallery Images.

ImageTemplatePowerShellCustomizer

تشغيل PowerShell المحدد على الجهاز الظاهري (Windows). يتوافق مع Packer powershell provisioner. يمكن تحديد واحد بالضبط من "scriptUri" أو "مضمن".

ImageTemplatePowerShellValidator

تشغيل البرنامج النصي PowerShell المحدد أثناء مرحلة التحقق من الصحة (Windows). يتوافق مع Packer powershell provisioner. يمكن تحديد واحد بالضبط من "scriptUri" أو "مضمن".

ImageTemplateProperties

يصف خصائص قالب الصورة

ImageTemplatePropertiesErrorHandling

خيارات معالجة الأخطاء عند فشل الإنشاء

ImageTemplatePropertiesOptimize

تحديد التحسين الذي سيتم تنفيذه على الصورة.

ImageTemplatePropertiesOptimizeVmBoot

يتم تطبيق التحسين على الصورة لتمهيد جهاز ظاهري أسرع.

ImageTemplatePropertiesOptimizeWorkload

يتم تطبيق التحسين على الصورة لأحمال عمل محددة.

ImageTemplatePropertiesValidate

خيارات التكوين وقائمة عمليات التحقق من الصحة التي سيتم إجراؤها على الصورة الناتجة.

ImageTemplateRestartCustomizer

إعادة تشغيل الجهاز الظاهري والانتظار حتى يعود عبر الإنترنت (Windows). يتوافق مع Packer windows-restart provisioner

ImageTemplateSharedImageDistributor

التوزيع عبر Azure Compute Gallery.

ImageTemplateSharedImageVersionSource

يصف مصدر صورة هو إصدار صورة في معرض حوسبة Azure أو معرض مشترك مباشر.

ImageTemplateShellCustomizer

تشغيل برنامج نصي shell أثناء مرحلة التخصيص (Linux). يتوافق مع Packer shell provisioner. يمكن تحديد واحد بالضبط من "scriptUri" أو "مضمن".

ImageTemplateShellValidator

تشغيل البرنامج النصي shell المحدد أثناء مرحلة التحقق من الصحة (Linux). يتوافق مع Packer shell provisioner. يمكن تحديد واحد بالضبط من "scriptUri" أو "مضمن".

ImageTemplateSource

توضح هذه المقالة مصدر صورة جهاز ظاهري لإنشاء وتخصيص وتوزيع

ImageTemplateUpdateParameters

معلمات لتحديث قالب صورة.

ImageTemplateUpdateParametersProperties

معلمات لتحديث قالب صورة.

ImageTemplateVhdDistributor

التوزيع عبر VHD في حساب تخزين.

ImageTemplateVmProfile

توضح هذه المقالة الأجهزة الظاهرية المستخدمة لإنشاء الصور والتحقق من صحتها

ImageTemplateWindowsUpdateCustomizer

تثبيت Windows Updates. يتوافق مع Packer Windows Update Provisioner (https://github.com/rgl/packer-provisioner-windows-update)

Operation

عملية واجهة برمجة تطبيقات REST

OperationDisplay

الكائن الذي يصف العملية.

OperationsListOptionalParams

المعلمات الاختيارية.

OperationsOperations

واجهة تمثل عمليات العمليات.

PageSettings

خيارات لأسلوب byPage

PagedAsyncIterableIterator

واجهة تسمح بالتكرار غير المتزامن حتى الاكتمال والصفحة.

PlatformImagePurchasePlan

تكوين خطة الشراء لصورة النظام الأساسي.

ProvisioningError

توضح هذه المقالة الخطأ الذي حدث عند إنشاء قالب صورة أو تحديثه

ProxyResource

تعريف نموذج المورد لمورد وكيل Azure Resource Manager. لن تحتوي على علامات وموقع

Resource

الحقول الشائعة التي يتم إرجاعها في الاستجابة لكافة موارد Azure Resource Manager

RestorePollerOptions
RunOutput

يمثل إخراجا تم إنشاؤه عن طريق تشغيل قالب صورة.

RunOutputProperties

يصف خصائص مخرجات التشغيل

SimplePollerLike

استقصاء بسيط يمكن استخدامه لاستقصاء عملية طويلة الأمد.

SourceImageTriggerProperties

خصائص نوع مشغل SourceImage

SystemData

بيانات التعريف المتعلقة بإنشاء المورد والتعديل الأخير له.

TargetRegion

توضح هذه المقالة معلومات المنطقة المستهدفة.

TrackedResource

تعريف نموذج المورد لمورد المستوى الأعلى ل Azure Resource Manager الذي يحتوي على "علامات" و"موقع"

Trigger

يمثل مشغلا يمكنه استدعاء بناء قالب صورة.

TriggerProperties

يصف خصائص المشغل

TriggerStatus

يصف حالة المشغل

TriggersCreateOrUpdateOptionalParams

المعلمات الاختيارية.

TriggersDeleteOptionalParams

المعلمات الاختيارية.

TriggersGetOptionalParams

المعلمات الاختيارية.

TriggersListByImageTemplateOptionalParams

المعلمات الاختيارية.

TriggersOperations

واجهة تمثل عمليات المحفز.

UserAssignedIdentity

خصائص الهوية المعينة من قبل المستخدم

VirtualMachineImageTemplatesCancelOptionalParams

المعلمات الاختيارية.

VirtualMachineImageTemplatesCreateOrUpdateOptionalParams

المعلمات الاختيارية.

VirtualMachineImageTemplatesDeleteOptionalParams

المعلمات الاختيارية.

VirtualMachineImageTemplatesGetOptionalParams

المعلمات الاختيارية.

VirtualMachineImageTemplatesGetRunOutputOptionalParams

المعلمات الاختيارية.

VirtualMachineImageTemplatesListByResourceGroupOptionalParams

المعلمات الاختيارية.

VirtualMachineImageTemplatesListOptionalParams

المعلمات الاختيارية.

VirtualMachineImageTemplatesListRunOutputsOptionalParams

المعلمات الاختيارية.

VirtualMachineImageTemplatesOperations

واجهة تمثل عمليات VirtualMachineImageTemplates.

VirtualMachineImageTemplatesRunOptionalParams

المعلمات الاختيارية.

VirtualMachineImageTemplatesUpdateOptionalParams

المعلمات الاختيارية.

VirtualNetworkConfig

تكوين الشبكة الظاهرية.

النوع أسماء مستعارة

AutoRunState

سيؤدي تمكين هذا الحقل إلى تشغيل بناء تلقائي على إنشاء قالب الصورة أو تحديثه.

AzureSupportedClouds

القيم المدعومة لإعداد السحابة كنوع حرفي للسلسلة

ContinuablePage

واجهة تصف صفحة من النتائج.

CreatedByType

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

القيم المعروفة التي تدعمها الخدمة

user: تم إنشاء الكيان بواسطة مستخدم.
application: تم إنشاء الكيان بواسطة تطبيق.
ManagedIdentity: تم إنشاء الكيان بواسطة هوية مدارة.
Key: تم إنشاء الكيان بواسطة مفتاح.

DistributeVersionerUnion

اسم مستعار ل DistributeVersionerUnion

ImageTemplateCustomizerUnion

اسم مستعار ل ImageTemplateCustomizerUnion

ImageTemplateDistributorUnion

اسم مستعار ل ImageTemplateDistributorUnion

ImageTemplateInVMValidatorUnion

اسم مستعار ل ImageTemplateInVMValidatorUnion

ImageTemplateSourceUnion

اسم مستعار ل ImageTemplateSourceUnion

OnBuildError

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

القيم المعروفة التي تدعمها الخدمة

التنظيف: التنظيف
إلغاء: إلغاء

ProvisioningErrorCode

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

القيم المعروفة التي تدعمها الخدمة

نوع المصدر السيء: نوع المصدر السيء
بادبيرسسورس: بادبيرس سورس
صورة سيئة مصدر: BadManagedImageمصدر
BadSharedImageVersionالمصدر: BadSharedImageVersionالمصدر
BadCustomizerType: BadCustomizerType
غير مدعومنوع التعديل: غير مدعوم نوع التخصيص
NoCustomizerScript: NoCustomizerScript
نوع المصحح السيء: نوع المدققين السيء
غير مدعوم: غير مدعوم: غير مدعوم. مصحق_نوع.
نوفاليديتور سكريبت: نوفاليديتور سكريبت
BadDistributeType: BadDistributeType
BadSharedImageDistribution
مجموعة BadStagingResourceGroup: مجموعة BadStagingResourceGroup
ServerError: ServerError
أخرى: أخرى

ProvisioningState

حالة توفير المورد

ReplicationMode

يصف وضع النسخ للتوزيع في معرض Azure Compute Gallery. استبعد استخدام الإعداد الافتراضي (الكامل).
يمكن استخدام KnownReplicationMode بالتبادل مع ReplicationMode، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

القيم المعروفة التي تدعمها الخدمة

الكامل: وضع النسخ الكامل
سطحي: وضع التكرار السطحي

ResourceIdentityType

نوع الهوية المستخدمة لقالب الصورة. سيقوم النوع "بلا" بإزالة أي هويات من قالب الصورة.

RunState

حالة الجولة الأخيرة

RunSubState

الحالة الفرعية للجولة الأخيرة

SharedImageStorageAccountType

يحدد نوع حساب التخزين المستخدم لتخزين نسخة صورة معرض Azure Compute Gallery.
KnownSharedImageStorageAccountType يمكن استخدامها بالتبادل مع SharedImageStorageAccountType، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

القيم المعروفة التي تدعمها الخدمة

Standard_LRS: Standard_LRS
Standard_ZRS: Standard_ZRS
Premium_LRS: Premium_LRS

TriggerPropertiesUnion

اسم مستعار ل TriggerPropertiesUnion

VMBootOptimizationState

سيؤدي تمكين هذا الحقل إلى تحسين وقت تمهيد الجهاز الظاهري عن طريق تحسين إخراج الصورة المخصص النهائي.

WorkloadOptimizationState

تفعيل هذا الحقل سيحسن صور الآلات الافتراضية لأحمال العمل المحددة.

التعدادات

AzureClouds

عدد لوصف بيئات Azure Cloud.

KnownCreatedByType

نوع الكيان الذي أنشأ المورد.

KnownOnBuildError

سلوك التعامل مع الأخطاء عند فشل البناء

KnownProvisioningErrorCode

رمز خطأ فشل التوفير

KnownReplicationMode

يصف وضع النسخ للتوزيع في معرض Azure Compute Gallery. استبعد استخدام الإعداد الافتراضي (الكامل).

KnownSharedImageStorageAccountType

يحدد نوع حساب التخزين المستخدم لتخزين نسخة صورة معرض Azure Compute Gallery.

KnownVersions

إصدارات واجهة برمجة التطبيقات المتوفرة.

الوظائف

isRestError(unknown)

Typeguard ل RestError

restorePoller<TResponse, TResult>(ImageBuilderClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

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

المتغيرات

RestError

نوع خطأ مخصص لطلبات البنية الأساسية لبرنامج ربط العمليات التجارية الفاشلة.

تفاصيل الوظيفة

isRestError(unknown)

Typeguard ل RestError

function isRestError(e: unknown): e

المعلمات

e

unknown

شيء ما تم التقاطه بواسطة عبارة catch.

المرتجعات

e

restorePoller<TResponse, TResult>(ImageBuilderClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

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

function restorePoller<TResponse, TResult>(client: ImageBuilderClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

المعلمات

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

المرتجعات

PollerLike<OperationState<TResult>, TResult>

تفاصيل المُتغيّر

RestError

نوع خطأ مخصص لطلبات البنية الأساسية لبرنامج ربط العمليات التجارية الفاشلة.

RestError: RestErrorConstructor

النوع