Microsoft.ApiManagement service/products

• الأحدث
• معاينة 2023-05-01
• معاينة 2023-03-01
• معاينة 2022-09-01
• 2022-08-01
• معاينة 2022-04-01
• معاينة 2021-12-01
• 2021-08-01
• معاينة 2021-04-01

تعريف مورد Bicep

يمكن نشر نوع مورد الخدمة/المنتجات مع العمليات التي تستهدف:

• مجموعات الموارد - راجع أوامر نشر مجموعة الموارد

للحصول على قائمة بالخصائص التي تم تغييرها في كل إصدار من إصدارات واجهة برمجة التطبيقات، راجع سجل التغيير.

تنسيق المورد

لإنشاء مورد Microsoft.ApiManagement/service/products، أضف Bicep التالي إلى القالب الخاص بك.

resource symbolicname 'Microsoft.ApiManagement/service/products@2023-05-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    approvalRequired: bool
    description: 'string'
    displayName: 'string'
    state: 'string'
    subscriptionRequired: bool
    subscriptionsLimit: int
    terms: 'string'
  }
}

قيم Property

الخدمة/المنتجات

الاسم	الوصف	القيمة
الاسم	اسم المورد تعرف على كيفية تعيين الأسماء والأنواع للموارد التابعة في Bicep.	سلسلة (مطلوب) حد الحرف: 1-80 أحرف صالحة: الأبجدية الرقمية والواصلات. يبدأ بالحرف وينتهي بالأبجدية الرقمية.
أصل	في Bicep، يمكنك تحديد المورد الأصل لمورد تابع. تحتاج فقط إلى إضافة هذه الخاصية عند الإعلان عن المورد التابع خارج المورد الأصل. لمزيد من المعلومات، راجع المورد التابع خارج المورد الأصل.	الاسم الرمزي للمورد من النوع: الخدمة
خصائص	خصائص عقد كيان المنتج.	ProductContractProperties

ProductContractProperties

الاسم	الوصف	القيمة
الموافقة المطلوبة	ما إذا كانت الموافقة على الاشتراك مطلوبة أم لا. إذا كانت خاطئة، فستتم الموافقة على الاشتراكات الجديدة تلقائيا لتمكين المطورين من استدعاء واجهات برمجة التطبيقات للمنتج مباشرة بعد الاشتراك. إذا كان صحيحا، يجب على المسؤولين الموافقة يدويا على الاشتراك قبل أن يتمكن المطور من أي من واجهات برمجة التطبيقات للمنتج. يمكن أن تكون موجودة فقط إذا كانت الخاصية subscriptionRequired موجودة ولها قيمة false.	Bool
الوصف	وصف المنتج. قد تتضمن علامات تنسيق HTML.	سلسلة
اسم المستخدم	اسم المنتج.	سلسلة (مطلوب)
حالة	ما إذا كان المنتج منشورا أم لا. المنتجات المنشورة قابلة للاكتشاف من قبل مستخدمي مدخل المطور. المنتجات غير المنشورة مرئية فقط للمسؤولين. الحالة الافتراضية للمنتج غير منشورة.	'notPublished' "منشور"
subscriptionRequired	ما إذا كان اشتراك المنتج مطلوبا للوصول إلى واجهات برمجة التطبيقات المضمنة في هذا المنتج. إذا كان صحيحا، يشار إلى المنتج باسم "محمي" ومفتاح اشتراك صالح مطلوب حتى ينجح طلب واجهة برمجة التطبيقات المضمنة في المنتج. إذا كان خطأ، يشار إلى المنتج باسم "فتح" ويمكن إجراء الطلبات إلى واجهة برمجة التطبيقات المضمنة في المنتج دون مفتاح اشتراك. إذا تم حذف الخاصية عند إنشاء منتج جديد، فمن المفترض أن تكون القيمة صحيحة.	Bool
subscriptionsLimit	ما إذا كان عدد الاشتراكات التي يمكن أن يمتلكها المستخدم لهذا المنتج في نفس الوقت. اضبط على null أو احذف للسماح باشتراكات غير محدودة لكل مستخدم. يمكن أن تكون موجودة فقط إذا كانت الخاصية subscriptionRequired موجودة ولها قيمة false.	int
الشروط	شروط استخدام المنتج. سيتم تقديم المطورين الذين يحاولون الاشتراك في المنتج ويطلب منهم قبول هذه الشروط قبل أن يتمكنوا من إكمال عملية الاشتراك.	سلسلة

قوالب التشغيل السريع

تنشر قوالب التشغيل السريع التالية نوع المورد هذا.

قالب	الوصف
إنشاء مثيل APIM وجميع الموارد الفرعية باستخدام القالب	يوضح هذا القالب كيفية إنشاء خدمة APIM وتكوين الكيانات الفرعية
إنشاء Azure Front Door أمام Azure API Management	يوضح هذا النموذج كيفية استخدام Azure Front Door كموازن تحميل عمومي أمام Azure API Management.

تعريف مورد قالب ARM

يمكن نشر نوع مورد الخدمة/المنتجات مع العمليات التي تستهدف:

• مجموعات الموارد - راجع أوامر نشر مجموعة الموارد

للحصول على قائمة بالخصائص التي تم تغييرها في كل إصدار من إصدارات واجهة برمجة التطبيقات، راجع سجل التغيير.

تنسيق المورد

لإنشاء مورد Microsoft.ApiManagement/service/products، أضف JSON التالي إلى القالب الخاص بك.

{
  "type": "Microsoft.ApiManagement/service/products",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "approvalRequired": "bool",
    "description": "string",
    "displayName": "string",
    "state": "string",
    "subscriptionRequired": "bool",
    "subscriptionsLimit": "int",
    "terms": "string"
  }
}

قيم Property

الخدمة/المنتجات

الاسم	الوصف	القيمة
النوع	نوع المورد	'Microsoft.ApiManagement/service/products'
apiVersion	إصدار واجهة برمجة تطبيقات المورد	'معاينة 2023-05-01'
الاسم	اسم المورد تعرف على كيفية تعيين الأسماء والأنواع للموارد التابعة في قوالب JSON ARM.	سلسلة (مطلوبة) حد الأحرف: 1-80 الأحرف الصالحة: الأبجدية الرقمية والواصلات. يبدأ بالحرف وينتهي بالأبجدية الرقمية.
خصائص	خصائص عقد كيان المنتج.	ProductContractProperties

ProductContractProperties

الاسم	الوصف	القيمة
الموافقة المطلوبة	ما إذا كانت الموافقة على الاشتراك مطلوبة أم لا. إذا كانت خاطئة، فستتم الموافقة على الاشتراكات الجديدة تلقائيا لتمكين المطورين من استدعاء واجهات برمجة التطبيقات للمنتج مباشرة بعد الاشتراك. إذا كان صحيحا، يجب على المسؤولين الموافقة يدويا على الاشتراك قبل أن يتمكن المطور من أي من واجهات برمجة التطبيقات للمنتج. يمكن أن تكون موجودة فقط إذا كانت الخاصية subscriptionRequired موجودة ولها قيمة خطأ.	Bool
الوصف	وصف المنتج. قد تتضمن علامات تنسيق HTML.	سلسلة
اسم المستخدم	اسم المنتج.	سلسلة (مطلوبة)
حالة	ما إذا كان المنتج منشورا أم لا. المنتجات المنشورة قابلة للاكتشاف من قبل مستخدمي مدخل المطور. المنتجات غير المنشورة مرئية فقط للمسؤولين. الحالة الافتراضية للمنتج غير منشورة.	'notPublished' "منشور"
subscriptionRequired	ما إذا كان اشتراك المنتج مطلوبا للوصول إلى واجهات برمجة التطبيقات المضمنة في هذا المنتج. إذا كان صحيحا، يشار إلى المنتج باسم "محمي" ويلزم مفتاح اشتراك صالح حتى ينجح طلب واجهة برمجة التطبيقات المضمنة في المنتج. إذا كان خطأ، يشار إلى المنتج باسم "مفتوح" ويمكن إجراء طلبات إلى واجهة برمجة تطبيقات مضمنة في المنتج دون مفتاح اشتراك. إذا تم حذف الخاصية عند إنشاء منتج جديد، فمن المفترض أن تكون القيمة صحيحة.	Bool
subscriptionsLimit	ما إذا كان عدد الاشتراكات التي يمكن أن يمتلكها المستخدم لهذا المنتج في نفس الوقت. تعيين إلى خال أو حذف للسماح باشتراكات غير محدودة لكل مستخدم. يمكن أن تكون موجودة فقط إذا كانت الخاصية subscriptionRequired موجودة ولها قيمة خطأ.	int
الشروط	شروط استخدام المنتج. سيتم تقديم المطورين الذين يحاولون الاشتراك في المنتج ويطلب منهم قبول هذه الشروط قبل أن يتمكنوا من إكمال عملية الاشتراك.	سلسلة

قوالب التشغيل السريع

تنشر قوالب التشغيل السريع التالية نوع المورد هذا.

قالب	الوصف
إنشاء مثيل APIM وجميع الموارد الفرعية باستخدام القالب	يوضح هذا القالب كيفية إنشاء خدمة APIM وتكوين الكيانات الفرعية
إنشاء Azure Front Door أمام إدارة واجهة برمجة تطبيقات Azure	يوضح هذا النموذج كيفية استخدام Azure Front Door كموازن تحميل عمومي أمام Azure API Management.

تعريف مورد Terraform (موفر AzAPI)

يمكن توزيع نوع مورد الخدمة/المنتجات مع العمليات التي تستهدف:

• مجموعات الموارد

للحصول على قائمة بالخصائص التي تم تغييرها في كل إصدار من إصدارات واجهة برمجة التطبيقات، راجع سجل التغيير.

تنسيق المورد

لإنشاء مورد Microsoft.ApiManagement/service/products، أضف Terraform التالي إلى القالب الخاص بك.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/products@2023-05-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      approvalRequired = bool
      description = "string"
      displayName = "string"
      state = "string"
      subscriptionRequired = bool
      subscriptionsLimit = int
      terms = "string"
    }
  })
}

قيم Property

الخدمة/المنتجات

الاسم	الوصف	القيمة
النوع	نوع المورد	"Microsoft.ApiManagement/service/products@2023-05-01-preview"
الاسم	اسم المورد	سلسلة (مطلوبة) حد الأحرف: 1-80 الأحرف الصالحة: الأبجدية الرقمية والواصلات. يبدأ بالحرف وينتهي بالأبجدية الرقمية.
parent_id	معرف المورد الأصل لهذا المورد.	معرف المورد من النوع: الخدمة
خصائص	خصائص عقد كيان المنتج.	ProductContractProperties

ProductContractProperties

الاسم	الوصف	القيمة
الموافقة المطلوبة	ما إذا كانت الموافقة على الاشتراك مطلوبة أم لا. إذا كانت خاطئة، فستتم الموافقة على الاشتراكات الجديدة تلقائيا لتمكين المطورين من استدعاء واجهات برمجة التطبيقات للمنتج مباشرة بعد الاشتراك. إذا كان صحيحا، يجب على المسؤولين الموافقة يدويا على الاشتراك قبل أن يتمكن المطور من أي من واجهات برمجة التطبيقات للمنتج. يمكن أن تكون موجودة فقط إذا كانت الخاصية subscriptionRequired موجودة ولها قيمة خطأ.	Bool
الوصف	وصف المنتج. قد تتضمن علامات تنسيق HTML.	سلسلة
اسم المستخدم	اسم المنتج.	سلسلة (مطلوبة)
حالة	ما إذا كان المنتج منشورا أم لا. المنتجات المنشورة قابلة للاكتشاف من قبل مستخدمي مدخل المطور. المنتجات غير المنشورة مرئية فقط للمسؤولين. الحالة الافتراضية للمنتج غير منشورة.	"notPublished" "تم النشر"
subscriptionRequired	ما إذا كان اشتراك المنتج مطلوبا للوصول إلى واجهات برمجة التطبيقات المضمنة في هذا المنتج. إذا كان صحيحا، يشار إلى المنتج باسم "محمي" ويلزم مفتاح اشتراك صالح حتى ينجح طلب واجهة برمجة التطبيقات المضمنة في المنتج. إذا كان خطأ، يشار إلى المنتج باسم "مفتوح" ويمكن إجراء طلبات إلى واجهة برمجة تطبيقات مضمنة في المنتج دون مفتاح اشتراك. إذا تم حذف الخاصية عند إنشاء منتج جديد، فمن المفترض أن تكون القيمة صحيحة.	Bool
subscriptionsLimit	ما إذا كان عدد الاشتراكات التي يمكن أن يمتلكها المستخدم لهذا المنتج في نفس الوقت. تعيين إلى خال أو حذف للسماح باشتراكات غير محدودة لكل مستخدم. يمكن أن تكون موجودة فقط إذا كانت الخاصية subscriptionRequired موجودة ولها قيمة خطأ.	int
الشروط	شروط استخدام المنتج. سيتم تقديم المطورين الذين يحاولون الاشتراك في المنتج ويطلب منهم قبول هذه الشروط قبل أن يتمكنوا من إكمال عملية الاشتراك.	سلسلة