Share via

Provisioning Microsoft.DevicesServices 2020-01-01

  • Article

Définition de ressource Bicep

Le type de ressource provisioningServices peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.Devices/provisioningServices, ajoutez le Bicep suivant à votre modèle.

resource symbolicname 'Microsoft.Devices/provisioningServices@2020-01-01' = {
  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'
      }
    ]
    iotHubs: [
      {
        allocationWeight: int
        applyAllocationPolicy: bool
        connectionString: 'string'
        location: 'string'
      }
    ]
    ipFilterRules: [
      {
        action: 'string'
        filterName: 'string'
        ipMask: 'string'
        target: 'string'
      }
    ]
    provisioningState: 'string'
    state: 'string'
  }
}

Valeurs de propriétés

provisioningServices

Nom Description Valeur
name Nom de la ressource string (obligatoire)

Limite de caractères : 3-64

Caractères valides :
Caractères alphanumériques et traits d’union.

Doit se terminer par un caractère alphanumérique.
location Emplacement de la ressource. string (obligatoire)
tags Étiquettes de la ressource. Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
sku Informations de référence SKU pour un service d’approvisionnement. IotDpsSkuInfo (obligatoire)
etag Le champ Etag n’est pas obligatoire. Si elle est fournie dans le corps de la réponse, elle doit également être fournie en tant qu’en-tête conformément à la convention ETag normale. string
properties Propriétés spécifiques au service pour un service d’approvisionnement IotDpsPropertiesDescription (obligatoire)

IotDpsPropertiesDescription

Nom Description Valeur
allocationPolicy Stratégie d’allocation à utiliser par ce service d’approvisionnement. 'GeoLatency'
'Hashed'
'Static'
authorizationPolicies Liste des clés d’autorisation pour un service d’approvisionnement. SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
iotHubs Liste des hubs IoT associés à ce service d’approvisionnement. IotHubDefinitionDescription[]
ipFilterRules Règles de filtre IP. IpFilterRule[]
provisioningState État d’approvisionnement ARM du service d’approvisionnement. string
state État actuel du service d’approvisionnement. 'Activation'
'ActivationFailed'
'Active'
'Supprimé'
'Suppression'
'SuppressionFailed'
'FailingOver'
'FailoverFailed'
'Reprise'
'Suspendu'
'Suspension'
'Transition'

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

Nom Description Valeur
keyName Nom de la clé. string (obligatoire)
primaryKey Valeur de clé SAS primaire. string
droits Droits dont dispose cette clé. 'DeviceConnect'
'EnrollmentRead'
'EnrollmentWrite'
'RegistrationStatusRead'
'RegistrationStatusWrite'
'ServiceConfig' (obligatoire)
secondaryKey Valeur de clé SAS secondaire. string
keyName Nom de la clé. string (obligatoire)
primaryKey Valeur de clé SAS primaire. string
droits Droits dont dispose cette clé. 'DeviceConnect'
'EnrollmentRead'
'EnrollmentWrite'
'RegistrationStatusRead'
'RegistrationStatusWrite'
'ServiceConfig' (obligatoire)
secondaryKey Valeur de clé SAS secondaire. string

IotHubDefinitionDescription

Nom Description Valeur
allocationWeight poids à appliquer pour un iot h donné. int
applyAllocationPolicy indicateur permettant d’appliquer allocationPolicy ou non à un hub iot donné. bool
connectionString Chaîne de connexion og le hub IoT. string (obligatoire)
location Région ARM du hub IoT. string (obligatoire)

IpFilterRule

Nom Description Valeur
action Action souhaitée pour les demandes capturées par cette règle. 'Accepter'
'Reject' (obligatoire)
filterName Nom de la règle de filtre IP. string (obligatoire)
ipMask Chaîne qui contient la plage d’adresses IP en notation CIDR pour la règle. string (obligatoire)
target Cible pour les demandes capturées par cette règle. 'all'
'deviceApi'
'serviceApi'

IotDpsSkuInfo

Nom Description Valeur
capacité Nombre d’unités à provisionner int
name Nom de la référence SKU. 'S1'

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle Description
Créer un simulateur de périphérie IOT Hub et Ubuntu

Déployer sur Azure		 Ce modèle crée un hub IOT et un simulateur de périphérie Ubuntu de machine virtuelle.
Créer un service IoT Hub Device Provisioning

Déployer sur Azure		 Ce modèle vous permet de créer un hub IoT et un service IoT Hub Device Provisioning, et de lier les deux services.

Définition de ressources de modèle ARM

Le type de ressource provisioningServices peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.Devices/provisioningServices, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.Devices/provisioningServices",
  "apiVersion": "2020-01-01",
  "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"
      }
    ],
    "iotHubs": [
      {
        "allocationWeight": "int",
        "applyAllocationPolicy": "bool",
        "connectionString": "string",
        "location": "string"
      }
    ],
    "ipFilterRules": [
      {
        "action": "string",
        "filterName": "string",
        "ipMask": "string",
        "target": "string"
      }
    ],
    "provisioningState": "string",
    "state": "string"
  }
}

Valeurs de propriétés

provisioningServices

Nom Description Valeur
type Type de ressource 'Microsoft.Devices/provisioningServices'
apiVersion Version de l’API de ressource '2020-01-01'
name Nom de la ressource string (obligatoire)

Limite de caractères : 3-64

Caractères valides :
Caractères alphanumériques et traits d’union.

Doit se terminer par un caractère alphanumérique.
location Emplacement de la ressource. chaîne (obligatoire)
tags Étiquettes de la ressource. Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
sku Informations de référence Sku pour un service d’approvisionnement. IotDpsSkuInfo (obligatoire)
etag Le champ Etag n’est pas obligatoire. S’il est fourni dans le corps de la réponse, il doit également être fourni en tant qu’en-tête conformément à la convention ETag normale. string
properties Propriétés spécifiques au service pour un service d’approvisionnement IotDpsPropertiesDescription (obligatoire)

IotDpsPropertiesDescription

Nom Description Valeur
allocationPolicy Stratégie d’allocation à utiliser par ce service d’approvisionnement. 'GeoLatency'
'Hachage'
'Statique'
authorizationPolicies Liste des clés d’autorisation pour un service d’approvisionnement. SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
iotHubs Liste des hubs IoT associés à ce service d’approvisionnement. IotHubDefinitionDescription[]
ipFilterRules Règles de filtre IP. IpFilterRule[]
provisioningState État d’approvisionnement ARM du service d’approvisionnement. string
state État actuel du service d’approvisionnement. 'Activation'
'ActivationFailed'
'Active'
'Supprimé'
'Suppression'
« Échec de suppression »
'FailingOver'
Échec du basculement
'Reprise'
'Suspendu'
'Suspension'
« Transition »

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

Nom Description Valeur
keyName Nom de la clé. chaîne (obligatoire)
primaryKey Valeur de clé SAP principale. string
droits Droits dont cette clé dispose. 'DeviceConnect'
'EnrollmentRead'
'EnrollmentWrite'
'RegistrationStatusRead'
'RegistrationStatusWrite'
'ServiceConfig' (obligatoire)
secondaryKey Valeur de clé SAS secondaire. string
keyName Nom de la clé. chaîne (obligatoire)
primaryKey Valeur de clé SAP principale. string
droits Droits dont cette clé dispose. 'DeviceConnect'
'EnrollmentRead'
'EnrollmentWrite'
'RegistrationStatusRead'
'RegistrationStatusWrite'
'ServiceConfig' (obligatoire)
secondaryKey Valeur de clé SAS secondaire. string

IotHubDefinitionDescription

Nom Description Valeur
allocationWeight poids à appliquer pour un iot h donné. int
applyAllocationPolicy indicateur permettant d’appliquer allocationPolicy ou non à un hub iot donné. bool
connectionString Chaîne de connexion og le hub IoT. string (obligatoire)
location Région ARM du hub IoT. string (obligatoire)

IpFilterRule

Nom Description Valeur
action Action souhaitée pour les demandes capturées par cette règle. 'Accepter'
'Reject' (obligatoire)
filterName Nom de la règle de filtre IP. string (obligatoire)
ipMask Chaîne qui contient la plage d’adresses IP en notation CIDR pour la règle. string (obligatoire)
target Cible pour les demandes capturées par cette règle. 'all'
'deviceApi'
'serviceApi'

IotDpsSkuInfo

Nom Description Valeur
capacité Nombre d’unités à provisionner int
name Nom de la référence SKU. 'S1'

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle Description
Créer un simulateur de périphérie IOT Hub et Ubuntu

Déployer sur Azure		 Ce modèle crée un hub IOT et un simulateur de périphérie Ubuntu de machine virtuelle.
Créer un service IoT Hub Device Provisioning

Déployer sur Azure		 Ce modèle vous permet de créer un hub IoT et un service IoT Hub Device Provisioning, et de lier les deux services.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource provisioningServices peut être déployé avec des opérations qui ciblent :

  • Groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.Devices/provisioningServices, ajoutez le Terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Devices/provisioningServices@2020-01-01"
  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"
        }
      ]
      iotHubs = [
        {
          allocationWeight = int
          applyAllocationPolicy = bool
          connectionString = "string"
          location = "string"
        }
      ]
      ipFilterRules = [
        {
          action = "string"
          filterName = "string"
          ipMask = "string"
          target = "string"
        }
      ]
      provisioningState = "string"
      state = "string"
    }
    sku = {
      capacity = int
      name = "S1"
    }
    etag = "string"
  })
}

Valeurs de propriétés

provisioningServices

Nom Description Valeur
type Type de ressource « Microsoft.Devices/provisioningServices@2020-01-01 »
name Nom de la ressource string (obligatoire)

Limite de caractères : 3-64

Caractères valides :
Caractères alphanumériques et traits d’union.

Doit se terminer par un caractère alphanumérique.
location Emplacement de la ressource. string (obligatoire)
parent_id Pour effectuer un déploiement dans un groupe de ressources, utilisez l’ID de ce groupe de ressources. string (obligatoire)
tags Étiquettes de la ressource. Dictionnaire de noms et de valeurs d’étiquettes.
sku Informations de référence SKU pour un service d’approvisionnement. IotDpsSkuInfo (obligatoire)
etag Le champ Etag n’est pas obligatoire. Si elle est fournie dans le corps de la réponse, elle doit également être fournie en tant qu’en-tête conformément à la convention ETag normale. string
properties Propriétés spécifiques au service pour un service d’approvisionnement IotDpsPropertiesDescription (obligatoire)

IotDpsPropertiesDescription

Nom Description Valeur
allocationPolicy Stratégie d’allocation à utiliser par ce service d’approvisionnement. « GeoLatency »
« Haché »
« Statique »
authorizationPolicies Liste des clés d’autorisation pour un service d’approvisionnement. SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
iotHubs Liste des hubs IoT associés à ce service d’approvisionnement. IotHubDefinitionDescription[]
ipFilterRules Règles de filtre IP. IpFilterRule[]
provisioningState État d’approvisionnement ARM du service d’approvisionnement. string
state État actuel du service d’approvisionnement. « Activation »
« ActivationFailed »
« Actif »
« Supprimé »
« Suppression »
« SuppressionFailed »
« FailingOver »
« Échec du basculement »
« Reprise »
« Suspendu »
« Suspension »
« Transition »

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

Nom Description Valeur
keyName Nom de la clé. string (obligatoire)
primaryKey Valeur de clé SAS primaire. string
droits Droits dont dispose cette clé. « DeviceConnect »
« EnrollmentRead »
« EnrollmentWrite »
« RegistrationStatusRead »
« RegistrationStatusWrite »
« ServiceConfig » (obligatoire)
secondaryKey Valeur de clé SAS secondaire. string
keyName Nom de la clé. string (obligatoire)
primaryKey Valeur de clé SAS primaire. string
droits Droits dont dispose cette clé. « DeviceConnect »
« EnrollmentRead »
« EnrollmentWrite »
« RegistrationStatusRead »
« RegistrationStatusWrite »
« ServiceConfig » (obligatoire)
secondaryKey Valeur de clé SAS secondaire. string

IotHubDefinitionDescription

Nom Description Valeur
allocationWeight poids à appliquer pour un iot h donné. int
applyAllocationPolicy indicateur permettant d’appliquer allocationPolicy ou non à un hub iot donné. bool
connectionString Chaîne de connexion og le hub IoT. string (obligatoire)
location Région ARM du hub IoT. string (obligatoire)

IpFilterRule

Nom Description Valeur
action Action souhaitée pour les demandes capturées par cette règle. « Accepter »
« Reject » (obligatoire)
filterName Nom de la règle de filtre IP. string (obligatoire)
ipMask Chaîne qui contient la plage d’adresses IP en notation CIDR pour la règle. string (obligatoire)
target Cible pour les demandes capturées par cette règle. « all »
« deviceApi »
« serviceApi »

IotDpsSkuInfo

Nom Description Valeur
capacité Nombre d’unités à provisionner int
name Nom de la référence SKU. « S1 »