Microsoft.ApiManagement الخدمة/المنتجات 2019-01-01

تعريف مورد Bicep

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

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

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

أمثلة الاستخدام

عينات Bicep

مثال أساسي لنشر منتج إدارة واجهة برمجة التطبيقات.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource service 'Microsoft.ApiManagement/service@2021-08-01' = {
  name: resourceName
  location: location
  sku: {
    capacity: 0
    name: 'Consumption'
  }
  properties: {
    certificates: []
    customProperties: {
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11': 'false'
    }
    disableGateway: false
    publicNetworkAccess: 'Enabled'
    publisherEmail: 'pub1@email.com'
    publisherName: 'pub1'
    virtualNetworkType: 'None'
  }
}

resource product 'Microsoft.ApiManagement/service/products@2021-08-01' = {
  name: resourceName
  parent: service
  properties: {
    description: ''
    displayName: 'Test Product'
    state: 'notPublished'
    subscriptionRequired: false
    terms: ''
  }
}

الوحدات النمطية التي تم التحقق منها من Azure

يمكن استخدام الوحدات النمطية Azure Verified لنشر نوع المورد هذا.

وحدة وصف
خدمة إدارة API - المنتج وحدة AVM الفرعية لخدمة إدارة واجهة برمجة التطبيقات - المنتج

تنسيق المورد

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

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

قيم الخصائص

Microsoft.ApiManagement/service/products

اسم وصف قيمة
اسم اسم المورد خيط

القيود:
الحد الأدنى للطول = 1
الحد الأقصى للطول = 256 (مطلوب)
الوالد في Bicep، يمكنك تحديد المورد الأصل لمورد تابع. تحتاج فقط إلى إضافة هذه الخاصية عند الإعلان عن المورد التابع خارج المورد الأصل.

لمزيد من المعلومات، راجع مورد تابع خارج المورد الأصل.
اسم رمزي للمورد من النوع: خدمة
خصائص خصائص عقد كيان المنتج. ProductContractProperties

المنتجاتالاتفاقية

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

القيود:
الحد الأدنى للطول = 1
الحد الأقصى للطول = 1000
اسم العرض اسم المنتج. خيط

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

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

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

أمثلة الاستخدام

تنسيق المورد

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

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

قيم الخصائص

Microsoft.ApiManagement/service/products

اسم وصف قيمة
apiVersion إصدار واجهة برمجة التطبيقات '2019-01-01'
اسم اسم المورد خيط

القيود:
الحد الأدنى للطول = 1
الحد الأقصى للطول = 256 (مطلوب)
خصائص خصائص عقد كيان المنتج. ProductContractProperties
نوع نوع المورد 'Microsoft.ApiManagement/service/products'

المنتجاتالاتفاقية

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

القيود:
الحد الأدنى للطول = 1
الحد الأقصى للطول = 1000
اسم العرض اسم المنتج. خيط

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

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

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

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

أمثلة الاستخدام

عينات Terraform

مثال أساسي لنشر منتج إدارة واجهة برمجة التطبيقات.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "service" {
  type      = "Microsoft.ApiManagement/service@2021-08-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      certificates = [
      ]
      customProperties = {
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10"         = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11"         = "false"
      }
      disableGateway      = false
      publicNetworkAccess = "Enabled"
      publisherEmail      = "pub1@email.com"
      publisherName       = "pub1"
      virtualNetworkType  = "None"
    }
    sku = {
      capacity = 0
      name     = "Consumption"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "product" {
  type      = "Microsoft.ApiManagement/service/products@2021-08-01"
  parent_id = azapi_resource.service.id
  name      = var.resource_name
  body = {
    properties = {
      description          = ""
      displayName          = "Test Product"
      state                = "notPublished"
      subscriptionRequired = false
      terms                = ""
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

تنسيق المورد

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

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

قيم الخصائص

Microsoft.ApiManagement/service/products

اسم وصف قيمة
اسم اسم المورد خيط

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

المنتجاتالاتفاقية

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

القيود:
الحد الأدنى للطول = 1
الحد الأقصى للطول = 1000
اسم العرض اسم المنتج. خيط

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