Microsoft.Devices provisioningServices 2022-12-12

Article
10/26/2024

Définition de ressource Bicep

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

groupes de ressources - Consultez commandes de déploiement de groupes de ressources

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

Format de ressource

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

resource symbolicname 'Microsoft.Devices/provisioningServices@2022-12-12' = {
  etag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    allocationPolicy: 'string'
    authorizationPolicies: [
      {
        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'
      }
    ]
    portalOperationsHostName: 'string'
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
        }
      }
    ]
    provisioningState: 'string'
    publicNetworkAccess: 'string'
    state: 'string'
  }
  resourcegroup: 'string'
  sku: {
    capacity: int
    name: 'string'
  }
  subscriptionid: 'string'
  tags: {
    {customized property}: 'string'
  }
}

Valeurs de propriété

IotDpsPropertiesDescription

Nom	Description	Valeur
allocationPolicy	Stratégie d’allocation à utiliser par ce service d’approvisionnement.	'GeoLatency' 'Hachage' 'Static'
authorizationPolicies	Liste des clés d’autorisation pour un service d’approvisionnement.	SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]
enableDataResidency	Optionnel. Indique si l’instance DPS a activé la résidence des données, en supprimant la récupération d’urgence inter-paires.	Bool
iotHubs	Liste des hubs IoT associés à ce service d’approvisionnement.	IotHubDefinitionDescription[]
ipFilterRules	Règles de filtre IP.	IpFilterRule []
portalOperationsHostName	Point de terminaison du portail pour activer CORS pour ce service d’approvisionnement.	corde
privateEndpointConnections	Connexions de point de terminaison privé créées sur cet IotHub	PrivateEndpointConnection[]
provisioningState	État d’approvisionnement ARM du service d’approvisionnement.	corde
publicNetworkAccess	Indique si les demandes du réseau public sont autorisées	'Désactivé' 'Activé'
état	État actuel du service d’approvisionnement.	'Activation' 'ActivationFailed' 'Actif' 'Supprimé' 'Suppression' 'Suppression ayant échoué' 'FailingOver' « Basculement ayant échoué » 'Reprise' 'Suspendu' 'Suspending' « Transition »

IotDpsSkuInfo

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

IotHubDefinitionDescription

Nom	Description	Valeur
allocationWeight	poids à appliquer pour un iot h donné.	Int
applyAllocationPolicy	indicateur pour l’application d’allocationPolicy ou non pour un hub iot donné.	Bool
connectionString	Chaîne de connexion du hub IoT.	chaîne (obligatoire)
emplacement	Région ARM du hub IoT.	chaîne (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.	chaîne (obligatoire)
ipMask	Chaîne qui contient la plage d’adresses IP en notation CIDR pour la règle.	chaîne (obligatoire)
cible	Cible des requêtes capturées par cette règle.	'all' 'deviceApi' 'serviceApi'

Microsoft.Devices/provisioningServices

Nom	Description	Valeur
etag	Le champ Etag n’est pas requis. 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.	corde
emplacement	Emplacement de la ressource.	chaîne (obligatoire)
nom	Nom de la ressource	chaîne (obligatoire)
Propriétés	Propriétés spécifiques du service pour un service d’approvisionnement	IotDpsPropertiesDescription (obligatoire)
resourcegroup	Groupe de ressources de la ressource.	corde
Sku	Informations de référence SKU pour un service d’approvisionnement.	IotDpsSkuInfo (obligatoire)
subscriptionid	ID d’abonnement de la ressource.	corde
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

PrivateEndpoint

Nom	Description	Valeur

PrivateEndpointConnection

Nom	Description	Valeur
Propriétés	Propriétés d’une connexion de point de terminaison privé	PrivateEndpointConnectionProperties (obligatoire)

PrivateEndpointConnectionProperties

Nom	Description	Valeur
privateEndpoint	Propriété de point de terminaison privé d’une connexion de point de terminaison privé	PrivateEndpoint
privateLinkServiceConnectionState	État actuel d’une connexion de point de terminaison privé	PrivateLinkServiceConnectionState (obligatoire)

PrivateLinkServiceConnectionState

Nom	Description	Valeur
actionsRequired	Actions requises pour une connexion de point de terminaison privé	corde
description	Description de l’état actuel d’une connexion de point de terminaison privé	chaîne (obligatoire)
statut	État d’une connexion de point de terminaison privé	'Approuvé' 'Déconnecté' 'En attente' 'Rejeté' (obligatoire)

ResourceTags

Nom	Description	Valeur

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Nom	Description	Valeur
keyName	Nom de la clé.	chaîne (obligatoire)
primaryKey	Valeur de clé SAS primaire.	corde
droits	Droits que cette clé a.	'DeviceConnect' 'EnrollmentRead' 'EnrollmentWrite' 'RegistrationStatusRead' 'RegistrationStatusWrite' 'ServiceConfig' (obligatoire)
secondaryKey	Valeur de clé SAP secondaire.	corde

Exemples de démarrage rapide

Les exemples de démarrage rapide suivants déploient ce type de ressource.

Fichier Bicep	Description
créer un service IoT Hub Device Provisioning	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 de modèle ARM

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

groupes de ressources - Consultez commandes de déploiement de groupes de ressources

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

Format de ressource

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

{
  "type": "Microsoft.Devices/provisioningServices",
  "apiVersion": "2022-12-12",
  "name": "string",
  "etag": "string",
  "location": "string",
  "properties": {
    "allocationPolicy": "string",
    "authorizationPolicies": [
      {
        "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"
      }
    ],
    "portalOperationsHostName": "string",
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {
          },
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          }
        }
      }
    ],
    "provisioningState": "string",
    "publicNetworkAccess": "string",
    "state": "string"
  },
  "resourcegroup": "string",
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "subscriptionid": "string",
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de propriété

IotDpsPropertiesDescription

Nom	Description	Valeur
allocationPolicy	Stratégie d’allocation à utiliser par ce service d’approvisionnement.	'GeoLatency' 'Hachage' 'Static'
authorizationPolicies	Liste des clés d’autorisation pour un service d’approvisionnement.	SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]
enableDataResidency	Optionnel. Indique si l’instance DPS a activé la résidence des données, en supprimant la récupération d’urgence inter-paires.	Bool
iotHubs	Liste des hubs IoT associés à ce service d’approvisionnement.	IotHubDefinitionDescription[]
ipFilterRules	Règles de filtre IP.	IpFilterRule []
portalOperationsHostName	Point de terminaison du portail pour activer CORS pour ce service d’approvisionnement.	corde
privateEndpointConnections	Connexions de point de terminaison privé créées sur cet IotHub	PrivateEndpointConnection[]
provisioningState	État d’approvisionnement ARM du service d’approvisionnement.	corde
publicNetworkAccess	Indique si les demandes du réseau public sont autorisées	'Désactivé' 'Activé'
état	État actuel du service d’approvisionnement.	'Activation' 'ActivationFailed' 'Actif' 'Supprimé' 'Suppression' 'Suppression ayant échoué' 'FailingOver' « Basculement ayant échoué » 'Reprise' 'Suspendu' 'Suspending' « Transition »

IotDpsSkuInfo

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

IotHubDefinitionDescription

Nom	Description	Valeur
allocationWeight	poids à appliquer pour un iot h donné.	Int
applyAllocationPolicy	indicateur pour l’application d’allocationPolicy ou non pour un hub iot donné.	Bool
connectionString	Chaîne de connexion du hub IoT.	chaîne (obligatoire)
emplacement	Région ARM du hub IoT.	chaîne (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.	chaîne (obligatoire)
ipMask	Chaîne qui contient la plage d’adresses IP en notation CIDR pour la règle.	chaîne (obligatoire)
cible	Cible des requêtes capturées par cette règle.	'all' 'deviceApi' 'serviceApi'

Microsoft.Devices/provisioningServices

Nom	Description	Valeur
apiVersion	Version de l’API	'2022-12-12'
etag	Le champ Etag n’est pas requis. 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.	corde
emplacement	Emplacement de la ressource.	chaîne (obligatoire)
nom	Nom de la ressource	chaîne (obligatoire)
Propriétés	Propriétés spécifiques du service pour un service d’approvisionnement	IotDpsPropertiesDescription (obligatoire)
resourcegroup	Groupe de ressources de la ressource.	corde
Sku	Informations de référence SKU pour un service d’approvisionnement.	IotDpsSkuInfo (obligatoire)
subscriptionid	ID d’abonnement de la ressource.	corde
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type	Type de ressource	'Microsoft.Devices/provisioningServices'

PrivateEndpoint

Nom	Description	Valeur

PrivateEndpointConnection

Nom	Description	Valeur
Propriétés	Propriétés d’une connexion de point de terminaison privé	PrivateEndpointConnectionProperties (obligatoire)

PrivateEndpointConnectionProperties

Nom	Description	Valeur
privateEndpoint	Propriété de point de terminaison privé d’une connexion de point de terminaison privé	PrivateEndpoint
privateLinkServiceConnectionState	État actuel d’une connexion de point de terminaison privé	PrivateLinkServiceConnectionState (obligatoire)

PrivateLinkServiceConnectionState

Nom	Description	Valeur
actionsRequired	Actions requises pour une connexion de point de terminaison privé	corde
description	Description de l’état actuel d’une connexion de point de terminaison privé	chaîne (obligatoire)
statut	État d’une connexion de point de terminaison privé	'Approuvé' 'Déconnecté' 'En attente' 'Rejeté' (obligatoire)

ResourceTags

Nom	Description	Valeur

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Nom	Description	Valeur
keyName	Nom de la clé.	chaîne (obligatoire)
primaryKey	Valeur de clé SAS primaire.	corde
droits	Droits que cette clé a.	'DeviceConnect' 'EnrollmentRead' 'EnrollmentWrite' 'RegistrationStatusRead' 'RegistrationStatusWrite' 'ServiceConfig' (obligatoire)
secondaryKey	Valeur de clé SAP secondaire.	corde

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 IOT Hub et Ubuntu Edge	Ce modèle crée un simulateur de périphérie Ubuntu iOT Hub et machine virtuelle.
créer un service IoT Hub Device Provisioning	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 de l’API, consultez journal des modifications.

Format de ressource

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Devices/provisioningServices@2022-12-12"
  name = "string"
  etag = "string"
  location = "string"
  body = jsonencode({
    properties = {
      allocationPolicy = "string"
      authorizationPolicies = [
        {
          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"
        }
      ]
      portalOperationsHostName = "string"
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {
            }
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
          }
        }
      ]
      provisioningState = "string"
      publicNetworkAccess = "string"
      state = "string"
    }
  })
  resourcegroup = "string"
  sku = {
    capacity = int
    name = "string"
  }
  subscriptionid = "string"
  tags = {
    {customized property} = "string"
  }
}

Valeurs de propriété

IotDpsPropertiesDescription

Nom	Description	Valeur
allocationPolicy	Stratégie d’allocation à utiliser par ce service d’approvisionnement.	'GeoLatency' 'Hachage' 'Static'
authorizationPolicies	Liste des clés d’autorisation pour un service d’approvisionnement.	SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]
enableDataResidency	Optionnel. Indique si l’instance DPS a activé la résidence des données, en supprimant la récupération d’urgence inter-paires.	Bool
iotHubs	Liste des hubs IoT associés à ce service d’approvisionnement.	IotHubDefinitionDescription[]
ipFilterRules	Règles de filtre IP.	IpFilterRule []
portalOperationsHostName	Point de terminaison du portail pour activer CORS pour ce service d’approvisionnement.	corde
privateEndpointConnections	Connexions de point de terminaison privé créées sur cet IotHub	PrivateEndpointConnection[]
provisioningState	État d’approvisionnement ARM du service d’approvisionnement.	corde
publicNetworkAccess	Indique si les demandes du réseau public sont autorisées	'Désactivé' 'Activé'
état	État actuel du service d’approvisionnement.	'Activation' 'ActivationFailed' 'Actif' 'Supprimé' 'Suppression' 'Suppression ayant échoué' 'FailingOver' « Basculement ayant échoué » 'Reprise' 'Suspendu' 'Suspending' « Transition »

IotDpsSkuInfo

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

IotHubDefinitionDescription

Nom	Description	Valeur
allocationWeight	poids à appliquer pour un iot h donné.	Int
applyAllocationPolicy	indicateur pour l’application d’allocationPolicy ou non pour un hub iot donné.	Bool
connectionString	Chaîne de connexion du hub IoT.	chaîne (obligatoire)
emplacement	Région ARM du hub IoT.	chaîne (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.	chaîne (obligatoire)
ipMask	Chaîne qui contient la plage d’adresses IP en notation CIDR pour la règle.	chaîne (obligatoire)
cible	Cible des requêtes capturées par cette règle.	'all' 'deviceApi' 'serviceApi'

Microsoft.Devices/provisioningServices

Nom	Description	Valeur
etag	Le champ Etag n’est pas requis. 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.	corde
emplacement	Emplacement de la ressource.	chaîne (obligatoire)
nom	Nom de la ressource	chaîne (obligatoire)
Propriétés	Propriétés spécifiques du service pour un service d’approvisionnement	IotDpsPropertiesDescription (obligatoire)
resourcegroup	Groupe de ressources de la ressource.	corde
Sku	Informations de référence SKU pour un service d’approvisionnement.	IotDpsSkuInfo (obligatoire)
subscriptionid	ID d’abonnement de la ressource.	corde
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes.
type	Type de ressource	« Microsoft.Devices/provisioningServices@2022-12-12 »

PrivateEndpoint

Nom	Description	Valeur

PrivateEndpointConnection

Nom	Description	Valeur
Propriétés	Propriétés d’une connexion de point de terminaison privé	PrivateEndpointConnectionProperties (obligatoire)

PrivateEndpointConnectionProperties

Nom	Description	Valeur
privateEndpoint	Propriété de point de terminaison privé d’une connexion de point de terminaison privé	PrivateEndpoint
privateLinkServiceConnectionState	État actuel d’une connexion de point de terminaison privé	PrivateLinkServiceConnectionState (obligatoire)

PrivateLinkServiceConnectionState

Nom	Description	Valeur
actionsRequired	Actions requises pour une connexion de point de terminaison privé	corde
description	Description de l’état actuel d’une connexion de point de terminaison privé	chaîne (obligatoire)
statut	État d’une connexion de point de terminaison privé	'Approuvé' 'Déconnecté' 'En attente' 'Rejeté' (obligatoire)

ResourceTags

Nom	Description	Valeur

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Nom	Description	Valeur
keyName	Nom de la clé.	chaîne (obligatoire)
primaryKey	Valeur de clé SAS primaire.	corde
droits	Droits que cette clé a.	'DeviceConnect' 'EnrollmentRead' 'EnrollmentWrite' 'RegistrationStatusRead' 'RegistrationStatusWrite' 'ServiceConfig' (obligatoire)
secondaryKey	Valeur de clé SAP secondaire.	corde

Partager via

Microsoft.Devices provisioningServices 2022-12-12

Définition de ressource Bicep

Format de ressource

Valeurs de propriété

IotDpsPropertiesDescription

IotDpsSkuInfo

IotHubDefinitionDescription

IpFilterRule

Microsoft.Devices/provisioningServices

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

ResourceTags

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Exemples de démarrage rapide

Définition de ressource de modèle ARM

Format de ressource

Valeurs de propriété

IotDpsPropertiesDescription

IotDpsSkuInfo

IotHubDefinitionDescription

IpFilterRule

Microsoft.Devices/provisioningServices

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

ResourceTags

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Modèles de démarrage rapide

Définition de ressource Terraform (fournisseur AzAPI)

Format de ressource

Valeurs de propriété

IotDpsPropertiesDescription

IotDpsSkuInfo

IotHubDefinitionDescription

IpFilterRule

Microsoft.Devices/provisioningServices

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

ResourceTags

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Commentaires

Ressources supplémentaires