Share via

Microsoft.Devices provisioningServices 2021-10-15

  • مقالة

تعريف مورد Bicep

يمكن توزيع نوع مورد provisioningServices مع العمليات التي تستهدف:

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

تنسيق المورد

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

resource symbolicname 'Microsoft.Devices/provisioningServices@2021-10-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'S1'
  }
  etag: 'string'
  properties: {
    allocationPolicy: 'string'
    authorizationPolicies: [
      {
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
      }
    ]
    enableDataResidency: bool
    iotHubs: [
      {
        allocationWeight: int
        applyAllocationPolicy: bool
        connectionString: 'string'
        location: 'string'
      }
    ]
    ipFilterRules: [
      {
        action: 'string'
        filterName: 'string'
        ipMask: 'string'
        target: 'string'
      }
    ]
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
        }
      }
    ]
    provisioningState: 'string'
    publicNetworkAccess: 'string'
    state: 'string'
  }
}

قيم Property

خدمات تشغيل الخدمة

الاسم الوصف القيمة
الاسم اسم المورد سلسلة (مطلوبة)

حد الحرف: 3-64

الأحرف الصالحة:
الأبجدية الرقمية والواصلات.

الانتهاء بالأبجدية الرقمية.
الموقع موقع المورد. سلسلة (مطلوبة)
العلامات علامات الموارد. قاموس أسماء العلامات والقيم. راجع العلامات في القوالب
sku معلومات Sku لخدمة التزويد. IotDpsSkuInfo (مطلوب)
etag حقل Etag غير مطلوب. إذا تم توفيره في نص الاستجابة، فيجب أيضا توفيره كعنوان وفقا لاصطلاح ETag العادي. سلسلة
خصائص خصائص خاصة بالخدمة لخدمة التزويد IotDpsPropertiesDescription (مطلوب)

IotDpsPropertiesDescription

الاسم الوصف القيمة
نهج التخصيص نهج التخصيص الذي ستستخدمه خدمة التوفير هذه. "GeoLatency"
'تجزئة'
"ثابت"
نهج التخويل قائمة مفاتيح التخويل لخدمة التوفير. SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
enableDataResidency ‏‏اختياري.
يشير إلى ما إذا كان مثيل DPS قد تم تمكينه Data Residency، مما يؤدي إلى إزالة التعافي من الكوارث عبر الزوج الجغرافي.		 Bool
iotHubs قائمة بمراكز IoT المقترنة بخدمة التزويد هذه. IotHubDefinitionDescription[]
ipFilterRules قواعد عامل تصفية IP. IpFilterRule[]
اتصالات نقطة النهاية الخاصة اتصالات نقطة النهاية الخاصة التي تم إنشاؤها على IotHub هذا PrivateEndpointConnection[]
provisioningState حالة توفير ARM لخدمة التزويد. سلسلة
publicNetworkAccess ما إذا كان مسموحا بالطلبات الواردة من الشبكة العامة "معطل"
"ممكن"
حالة الحالة الحالية لخدمة التوفير. "التنشيط"
'ActivationFailed'
"نشط"
"محذوف"
"الحذف"
'DeleteionFailed'
"تجاوز الفشل"
'FailoverFailed'
"استئناف"
"معلق"
"تعليق"
"الانتقال"

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

الاسم الوصف القيمة
keyName اسم المفتاح. سلسلة (مطلوب)
primaryKey قيمة مفتاح SAS الأساسية. سلسلة
حقوق الحقوق التي يمتلكها هذا المفتاح. "اتصال الجهاز"
"EnrollmentRead"
"كتابة التسجيل"
"RegistrationStatusRead"
"RegistrationStatusWrite"
'ServiceConfig' (مطلوب)
مفتاح ثانوي قيمة مفتاح SAS الثانوية. سلسلة
keyName اسم المفتاح. سلسلة (مطلوب)
primaryKey قيمة مفتاح SAS الأساسية. سلسلة
حقوق الحقوق التي يمتلكها هذا المفتاح. "اتصال الجهاز"
"EnrollmentRead"
"كتابة التسجيل"
"RegistrationStatusRead"
"RegistrationStatusWrite"
'ServiceConfig' (مطلوب)
مفتاح ثانوي قيمة مفتاح SAS الثانوية. سلسلة

IotHubDefinitionDescription

الاسم الوصف القيمة
وزن التخصيص الوزن لتطبيق ل iot h معينة. int
applyAllocationPolicy علامة لتطبيق allocationPolicy أو لا لمركز iot معين. Bool
سلسلة الاتصال سلسلة الاتصال لمركز IoT. سلسلة (مطلوب)
الموقع منطقة ARM لمركز IoT. سلسلة (مطلوب)

IpFilterRule

الاسم الوصف القيمة
إجراء الإجراء المطلوب للطلبات التي تم التقاطها بواسطة هذه القاعدة. "قبول"
"رفض" (مطلوب)
اسم عامل التصفية اسم قاعدة عامل تصفية IP. سلسلة (مطلوب)
ipMask سلسلة تحتوي على نطاق عناوين IP في رمز CIDR للقاعدة. سلسلة (مطلوب)
الهدف الهدف للطلبات التي تم التقاطها بواسطة هذه القاعدة. 'الكل'
"deviceApi"
"serviceApi"

PrivateEndpointConnection

الاسم الوصف القيمة
خصائص خصائص اتصال نقطة نهاية خاصة PrivateEndpointConnectionProperties (مطلوب)

PrivateEndpointConnectionProperties

الاسم الوصف القيمة
نقطة النهاية الخاصة خاصية نقطة النهاية الخاصة لاتصال نقطة نهاية خاصة نقطة النهاية الخاصة
privateLinkServiceConnectionState الحالة الحالية لاتصال نقطة نهاية خاصة PrivateLinkServiceConnectionState (مطلوب)

نقطة النهاية الخاصة

لا يحتوي هذا الكائن على أي خصائص لتعيينها أثناء التوزيع. جميع الخصائص هي ReadOnly.

PrivateLinkServiceConnectionState

الاسم الوصف القيمة
الإجراءات مطلوبة الإجراءات المطلوبة لاتصال نقطة نهاية خاصة سلسلة
الوصف وصف الحالة الحالية لاتصال نقطة نهاية خاصة سلسلة (مطلوب)
الحالة حالة اتصال نقطة نهاية خاصة "تمت الموافقة"
"غير متصل"
"معلق"
"مرفوض" (مطلوب)

IotDpsSkuInfo

الاسم الوصف القيمة
السعة عدد الوحدات المراد توفيرها int
الاسم اسم Sku. 'S1'

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

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

قالب الوصف
إنشاء محاكي IOT Hub وUbuntu edge

نشر في Azure		 ينشئ هذا القالب IOT Hub ومحاكي Ubuntu Edge للجهاز الظاهري.
إنشاء خدمة توفير جهاز IoT Hub

نشر في Azure		 يمكنك هذا القالب من إنشاء مركز IoT وخدمة توفير جهاز IoT Hub، وربط الخدمتين معا.

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

يمكن نشر نوع مورد provisioningServices مع العمليات التي تستهدف:

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

تنسيق المورد

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

{
  "type": "Microsoft.Devices/provisioningServices",
  "apiVersion": "2021-10-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "S1"
  },
  "etag": "string",
  "properties": {
    "allocationPolicy": "string",
    "authorizationPolicies": [
      {
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string",
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string"
      }
    ],
    "enableDataResidency": "bool",
    "iotHubs": [
      {
        "allocationWeight": "int",
        "applyAllocationPolicy": "bool",
        "connectionString": "string",
        "location": "string"
      }
    ],
    "ipFilterRules": [
      {
        "action": "string",
        "filterName": "string",
        "ipMask": "string",
        "target": "string"
      }
    ],
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {},
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          }
        }
      }
    ],
    "provisioningState": "string",
    "publicNetworkAccess": "string",
    "state": "string"
  }
}

قيم Property

خدمات تشغيل الخدمة

الاسم الوصف القيمة
النوع نوع المورد 'Microsoft.Devices/provisioningServices'
apiVersion إصدار واجهة برمجة تطبيقات المورد '2021-10-15'
الاسم اسم المورد سلسلة (مطلوب)

حد الحرف: 3-64

أحرف صالحة:
الأبجدية الرقمية والواصلات.

الانتهاء بالأبجدية الرقمية.
الموقع موقع المورد. سلسلة (مطلوب)
العلامات علامات الموارد. قاموس أسماء العلامات والقيم. راجع العلامات في القوالب
sku معلومات Sku لخدمة التزويد. IotDpsSkuInfo (مطلوب)
etag حقل Etag غير مطلوب. إذا تم توفيره في نص الاستجابة، فيجب أيضا توفيره كعنوان وفقا لاصطلاح ETag العادي. سلسلة
خصائص الخصائص الخاصة بالخدمة لخدمة التزويد IotDpsPropertiesDescription (مطلوب)

IotDpsPropertiesDescription

الاسم الوصف القيمة
نهج التخصيص نهج التخصيص الذي ستستخدمه خدمة التوفير هذه. "GeoLatency"
"تجزئة"
'ثابت'
نهج التخويل قائمة مفاتيح التخويل لخدمة التوفير. SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
enableDataResidency ‏‏اختياري.
يشير إلى ما إذا كان مثيل DPS قد تم تمكينه Data Residency، مما يؤدي إلى إزالة التعافي من الكوارث عبر الزوج الجغرافي.		 Bool
iotHubs قائمة بمراكز IoT المقترنة بخدمة التزويد هذه. IotHubDefinitionDescription[]
ipFilterRules قواعد عامل تصفية IP. IpFilterRule[]
اتصالات نقطة النهاية الخاصة اتصالات نقطة النهاية الخاصة التي تم إنشاؤها على IotHub هذا PrivateEndpointConnection[]
provisioningState حالة توفير ARM لخدمة التوفير. سلسلة
publicNetworkAccess ما إذا كان مسموحا بالطلبات الواردة من الشبكة العامة "معطل"
"ممكن"
حالة الحالة الحالية لخدمة التوفير. "التنشيط"
'ActivationFailed'
"نشط"
"محذوف"
"الحذف"
'DeleteionFailed'
"تجاوز الفشل"
'FailoverFailed'
"استئناف"
"معلق"
"تعليق"
"الانتقال"

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

الاسم الوصف القيمة
keyName اسم المفتاح. سلسلة (مطلوب)
primaryKey قيمة مفتاح SAS الأساسية. سلسلة
حقوق الحقوق التي يمتلكها هذا المفتاح. "اتصال الجهاز"
"EnrollmentRead"
"كتابة التسجيل"
"RegistrationStatusRead"
"RegistrationStatusWrite"
'ServiceConfig' (مطلوب)
مفتاح ثانوي قيمة مفتاح SAS الثانوية. سلسلة
keyName اسم المفتاح. سلسلة (مطلوب)
primaryKey قيمة مفتاح SAS الأساسية. سلسلة
حقوق الحقوق التي يمتلكها هذا المفتاح. "اتصال الجهاز"
"EnrollmentRead"
"كتابة التسجيل"
"RegistrationStatusRead"
"RegistrationStatusWrite"
'ServiceConfig' (مطلوب)
مفتاح ثانوي قيمة مفتاح SAS الثانوية. سلسلة

IotHubDefinitionDescription

الاسم الوصف القيمة
وزن التخصيص الوزن لتطبيق ل iot h معينة. int
applyAllocationPolicy علامة لتطبيق allocationPolicy أو لا لمركز iot معين. Bool
سلسلة الاتصال سلسلة الاتصال لمركز IoT. سلسلة (مطلوب)
الموقع منطقة ARM لمركز IoT. سلسلة (مطلوب)

IpFilterRule

الاسم الوصف القيمة
إجراء الإجراء المطلوب للطلبات التي تم التقاطها بواسطة هذه القاعدة. "قبول"
"رفض" (مطلوب)
اسم عامل التصفية اسم قاعدة عامل تصفية IP. سلسلة (مطلوب)
ipMask سلسلة تحتوي على نطاق عناوين IP في رمز CIDR للقاعدة. سلسلة (مطلوب)
الهدف الهدف للطلبات التي تم التقاطها بواسطة هذه القاعدة. 'الكل'
"deviceApi"
"serviceApi"

PrivateEndpointConnection

الاسم الوصف القيمة
خصائص خصائص اتصال نقطة نهاية خاصة PrivateEndpointConnectionProperties (مطلوب)

PrivateEndpointConnectionProperties

الاسم الوصف القيمة
نقطة النهاية الخاصة خاصية نقطة النهاية الخاصة لاتصال نقطة نهاية خاصة نقطة النهاية الخاصة
privateLinkServiceConnectionState الحالة الحالية لاتصال نقطة نهاية خاصة PrivateLinkServiceConnectionState (مطلوب)

نقطة النهاية الخاصة

لا يحتوي هذا الكائن على أي خصائص لتعيينها أثناء التوزيع. جميع الخصائص هي ReadOnly.

PrivateLinkServiceConnectionState

الاسم الوصف القيمة
الإجراءات مطلوبة الإجراءات المطلوبة لاتصال نقطة نهاية خاصة سلسلة
الوصف وصف الحالة الحالية لاتصال نقطة نهاية خاصة سلسلة (مطلوب)
الحالة حالة اتصال نقطة نهاية خاصة "تمت الموافقة"
"غير متصل"
"معلق"
"مرفوض" (مطلوب)

IotDpsSkuInfo

الاسم الوصف القيمة
السعة عدد الوحدات المراد توفيرها int
الاسم اسم Sku. 'S1'

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

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

قالب الوصف
إنشاء محاكي IOT Hub وUbuntu edge

نشر في Azure		 ينشئ هذا القالب IOT Hub ومحاكي Ubuntu Edge للجهاز الظاهري.
إنشاء خدمة توفير جهاز IoT Hub

نشر في Azure		 يمكنك هذا القالب من إنشاء مركز IoT وخدمة توفير جهاز IoT Hub، وربط الخدمتين معا.

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

يمكن نشر نوع مورد provisioningServices مع العمليات التي تستهدف:

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

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

تنسيق المورد

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Devices/provisioningServices@2021-10-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      allocationPolicy = "string"
      authorizationPolicies = [
        {
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
          keyName = "string"
          primaryKey = "string"
          rights = "string"
          secondaryKey = "string"
        }
      ]
      enableDataResidency = bool
      iotHubs = [
        {
          allocationWeight = int
          applyAllocationPolicy = bool
          connectionString = "string"
          location = "string"
        }
      ]
      ipFilterRules = [
        {
          action = "string"
          filterName = "string"
          ipMask = "string"
          target = "string"
        }
      ]
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {}
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
          }
        }
      ]
      provisioningState = "string"
      publicNetworkAccess = "string"
      state = "string"
    }
    sku = {
      capacity = int
      name = "S1"
    }
    etag = "string"
  })
}

قيم Property

خدمات تشغيل الخدمة

الاسم الوصف القيمة
النوع نوع المورد "Microsoft.Devices/provisioningServices@2021-10-15"
الاسم اسم المورد سلسلة (مطلوب)

حد الحرف: 3-64

أحرف صالحة:
الأبجدية الرقمية والواصلات.

الانتهاء بالأبجدية الرقمية.
الموقع موقع المورد. سلسلة (مطلوب)
parent_id للنشر إلى مجموعة موارد، استخدم معرف مجموعة الموارد هذه. سلسلة (مطلوب)
العلامات علامات الموارد. قاموس أسماء العلامات والقيم.
sku معلومات Sku لخدمة التزويد. IotDpsSkuInfo (مطلوب)
etag حقل Etag غير مطلوب. إذا تم توفيره في نص الاستجابة، فيجب أيضا توفيره كعنوان وفقا لاصطلاح ETag العادي. سلسلة
خصائص الخصائص الخاصة بالخدمة لخدمة التزويد IotDpsPropertiesDescription (مطلوب)

IotDpsPropertiesDescription

الاسم الوصف القيمة
نهج التخصيص نهج التخصيص الذي ستستخدمه خدمة التوفير هذه. "GeoLatency"
"تجزئة"
"ثابت"
نهج التخويل قائمة مفاتيح التخويل لخدمة التوفير. SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
enableDataResidency ‏‏اختياري.
يشير إلى ما إذا كان مثيل DPS قد تم تمكينه Data Residency، مما يؤدي إلى إزالة التعافي من الكوارث عبر الزوج الجغرافي.		 Bool
iotHubs قائمة بمراكز IoT المقترنة بخدمة التزويد هذه. IotHubDefinitionDescription[]
ipFilterRules قواعد عامل تصفية IP. IpFilterRule[]
اتصالات نقطة النهاية الخاصة اتصالات نقطة النهاية الخاصة التي تم إنشاؤها على IotHub هذا PrivateEndpointConnection[]
provisioningState حالة توفير ARM لخدمة التزويد. سلسلة
publicNetworkAccess ما إذا كان مسموحا بالطلبات الواردة من الشبكة العامة "معطل"
"ممكن"
حالة الحالة الحالية لخدمة التوفير. "التنشيط"
"ActivationFailed"
"نشط"
"محذوف"
"حذف"
"DeleteionFailed"
"تجاوز الفشل"
"FailoverFailed"
"استئناف"
"معلق"
"تعليق"
"الانتقال"

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

الاسم الوصف القيمة
keyName اسم المفتاح. سلسلة (مطلوبة)
primaryKey قيمة مفتاح SAS الأساسية. سلسلة
حقوق الحقوق التي يمتلكها هذا المفتاح. "DeviceConnect"
"EnrollmentRead"
"كتابة التسجيل"
"RegistrationStatusRead"
"RegistrationStatusWrite"
"ServiceConfig" (مطلوب)
مفتاح ثانوي قيمة مفتاح SAS الثانوية. سلسلة
keyName اسم المفتاح. سلسلة (مطلوبة)
primaryKey قيمة مفتاح SAS الأساسية. سلسلة
حقوق الحقوق التي يمتلكها هذا المفتاح. "DeviceConnect"
"EnrollmentRead"
"كتابة التسجيل"
"RegistrationStatusRead"
"RegistrationStatusWrite"
"ServiceConfig" (مطلوب)
مفتاح ثانوي قيمة مفتاح SAS الثانوية. سلسلة

وصف IotHubDefinitionDescription

الاسم الوصف القيمة
وزن التخصيص الوزن لتطبيق ل iot h معينة. int
applyAllocationPolicy علامة لتطبيق allocationPolicy أم لا لمركز iot معين. Bool
سلسلة الاتصال سلسلة الاتصال لمركز IoT. سلسلة (مطلوبة)
الموقع منطقة ARM لمركز IoT. سلسلة (مطلوبة)

IpFilterRule

الاسم الوصف القيمة
إجراء الإجراء المطلوب للطلبات التي تم التقاطها بواسطة هذه القاعدة. "قبول"
"رفض" (مطلوب)
اسم عامل التصفية اسم قاعدة عامل تصفية IP. سلسلة (مطلوبة)
ipMask سلسلة تحتوي على نطاق عناوين IP في رمز CIDR للقاعدة. سلسلة (مطلوبة)
الهدف هدف للطلبات التي تم التقاطها بواسطة هذه القاعدة. "الكل"
"deviceApi"
"serviceApi"

PrivateEndpointConnection

الاسم الوصف القيمة
خصائص خصائص اتصال نقطة نهاية خاصة PrivateEndpointConnectionProperties (مطلوب)

PrivateEndpointConnectionProperties

الاسم الوصف القيمة
نقطة النهاية الخاصة خاصية نقطة النهاية الخاصة لاتصال نقطة نهاية خاصة نقطة النهاية الخاصة
privateLinkServiceConnectionState الحالة الحالية لاتصال نقطة نهاية خاصة PrivateLinkServiceConnectionState (مطلوب)

نقطة النهاية الخاصة

لا يحتوي هذا الكائن على أي خصائص لتعيينها أثناء التوزيع. جميع الخصائص هي ReadOnly.

PrivateLinkServiceConnectionState

الاسم الوصف القيمة
الإجراءات مطلوبة الإجراءات المطلوبة لاتصال نقطة نهاية خاصة سلسلة
الوصف وصف الحالة الحالية لاتصال نقطة نهاية خاصة سلسلة (مطلوب)
الحالة حالة اتصال نقطة نهاية خاصة "تمت الموافقة"
"غير متصل"
"معلق"
"مرفوض" (مطلوب)

IotDpsSkuInfo

الاسم الوصف القيمة
السعة عدد الوحدات المراد توفيرها int
الاسم اسم Sku. "S1"