Microsoft.Devices provisioningServices 2021-10-15

Articolo
12/09/2024

Definizione di risorsa Bicep

Il tipo di risorsa provisioningServices può essere distribuito con operazioni destinate a:

gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.Devices/provisioningServices, aggiungere il bicep seguente al modello.

resource symbolicname 'Microsoft.Devices/provisioningServices@2021-10-15' = {
  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'
      }
    ]
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
        }
      }
    ]
    provisioningState: 'string'
    publicNetworkAccess: 'string'
    state: 'string'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valori delle proprietà

IotDpsPropertiesDescription

Nome	Descrizione	Valore
allocationPolicy	Criteri di allocazione da usare da questo servizio di provisioning.	'GeoLatency' 'Hashed' 'Static'
authorizationPolicies	Elenco delle chiavi di autorizzazione per un servizio di provisioning.	SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]
enableDataResidency	Opzionale. Indica se l'istanza del servizio Device Provisioning ha la residenza dei dati abilitata, rimuovendo il ripristino di emergenza tra coppie geografiche.	Bool
iotHubs	Elenco degli hub IoT associati a questo servizio di provisioning.	IotHubDefinitionDescription[]
ipFilterRules	Regole di filtro IP.	IpFilterRule[]
privateEndpointConnections	Connessioni endpoint private create in questo IotHub	PrivateEndpointConnection[]
provisioningState	Stato di provisioning arm del servizio di provisioning.	corda
publicNetworkAccess	Indica se le richieste dalla rete pubblica sono consentite	'Disabilitato' 'Enabled'
stato	Stato corrente del servizio di provisioning.	'Attivazione' 'ActivationFailed' 'Attivo' 'Eliminato' 'Eliminazione' 'DeletionFailed' 'FailOver' 'FailoverFailed' 'Ripresa' 'Sospeso' 'Suspending' 'Transizione'

IotDpsSkuInfo

Nome	Descrizione	Valore
capacità	Numero di unità di cui effettuare il provisioning	Int
nome	Nome sku.	'S1'

IotHubDefinitionDescription

Nome	Descrizione	Valore
allocationWeight	peso da applicare per un determinato iot h.	Int
applyAllocationPolicy	flag per l'applicazione di allocationPolicy o meno per un determinato hub iot.	Bool
connectionString	Stringa di connessione dell'hub IoT.	stringa (obbligatorio)
ubicazione	Area arm dell'hub IoT.	stringa (obbligatorio)

IpFilterRule

Nome	Descrizione	Valore
azione	Azione desiderata per le richieste acquisite da questa regola.	'Accept' 'Reject' (obbligatorio)
filterName	Nome della regola di filtro IP.	stringa (obbligatorio)
ipMask	Stringa che contiene l'intervallo di indirizzi IP nella notazione CIDR per la regola.	stringa (obbligatorio)
bersaglio	Destinazione per le richieste acquisite da questa regola.	'all' 'deviceApi' 'serviceApi'

Microsoft.Devices/provisioningServices

Nome	Descrizione	Valore
etag	Il campo Etag è non obbligatorio. Se viene specificato nel corpo della risposta, deve anche essere fornito come intestazione in base alla normale convenzione ETag.	corda
ubicazione	Percorso della risorsa.	stringa (obbligatorio)
nome	Nome della risorsa	stringa (obbligatorio)
proprietà	Proprietà specifiche del servizio per un servizio di provisioning	IotDpsPropertiesDescription (obbligatorio)
Sku	Informazioni sullo SKU per un servizio di provisioning.	IotDpsSkuInfo (obbligatorio)
Tag	Tag delle risorse	Dizionario di nomi e valori di tag. Vedere tag nei modelli

PrivateEndpoint

Nome	Descrizione	Valore

PrivateEndpointConnection

Nome	Descrizione	Valore
proprietà	Proprietà di una connessione endpoint privato	PrivateEndpointConnectionProperties (obbligatorio)

PrivateEndpointConnectionProperties

Nome	Descrizione	Valore
privateEndpoint	Proprietà dell'endpoint privato di una connessione endpoint privato	PrivateEndpoint
privateLinkServiceConnectionState	Stato corrente di una connessione endpoint privato	PrivateLinkServiceConnectionState (obbligatorio)

PrivateLinkServiceConnectionState

Nome	Descrizione	Valore
actionsRequired	Azioni necessarie per una connessione all'endpoint privato	corda
descrizione	Descrizione dello stato corrente di una connessione endpoint privato	stringa (obbligatorio)
stato	Stato di una connessione endpoint privato	'Approvato' 'Disconnesso' 'In sospeso' 'Rejected' (obbligatorio)

ResourceTags

Nome	Descrizione	Valore

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Nome	Descrizione	Valore
keyName	Nome della chiave.	stringa (obbligatorio)
primaryKey	Valore della chiave di firma di accesso condiviso primario.	corda
diritti	Diritti di cui dispone la chiave.	'DeviceConnect' 'EnrollmentRead' 'EnrollmentWrite' 'RegistrationStatusRead' 'RegistrationStatusWrite' 'ServiceConfig' (obbligatorio)
secondaryKey	Valore della chiave di firma di accesso condiviso secondario.	corda

Esempi di avvio rapido

Gli esempi di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Bicep File	Descrizione
Creare un servizio Device Provisioning in hub IoT	Questo modello consente di creare un hub IoT e un servizio Device Provisioning in hub IoT e collegare i due servizi.

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa provisioningServices può essere distribuito con operazioni destinate a:

gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.Devices/provisioningServices, aggiungere il codice JSON seguente al modello.

{
  "type": "Microsoft.Devices/provisioningServices",
  "apiVersion": "2021-10-15",
  "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"
      }
    ],
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {
          },
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          }
        }
      }
    ],
    "provisioningState": "string",
    "publicNetworkAccess": "string",
    "state": "string"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valori delle proprietà

IotDpsPropertiesDescription

Nome	Descrizione	Valore
allocationPolicy	Criteri di allocazione da usare da questo servizio di provisioning.	'GeoLatency' 'Hashed' 'Static'
authorizationPolicies	Elenco delle chiavi di autorizzazione per un servizio di provisioning.	SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]
enableDataResidency	Opzionale. Indica se l'istanza del servizio Device Provisioning ha la residenza dei dati abilitata, rimuovendo il ripristino di emergenza tra coppie geografiche.	Bool
iotHubs	Elenco degli hub IoT associati a questo servizio di provisioning.	IotHubDefinitionDescription[]
ipFilterRules	Regole di filtro IP.	IpFilterRule[]
privateEndpointConnections	Connessioni endpoint private create in questo IotHub	PrivateEndpointConnection[]
provisioningState	Stato di provisioning arm del servizio di provisioning.	corda
publicNetworkAccess	Indica se le richieste dalla rete pubblica sono consentite	'Disabilitato' 'Enabled'
stato	Stato corrente del servizio di provisioning.	'Attivazione' 'ActivationFailed' 'Attivo' 'Eliminato' 'Eliminazione' 'DeletionFailed' 'FailOver' 'FailoverFailed' 'Ripresa' 'Sospeso' 'Suspending' 'Transizione'

IotDpsSkuInfo

Nome	Descrizione	Valore
capacità	Numero di unità di cui effettuare il provisioning	Int
nome	Nome sku.	'S1'

IotHubDefinitionDescription

Nome	Descrizione	Valore
allocationWeight	peso da applicare per un determinato iot h.	Int
applyAllocationPolicy	flag per l'applicazione di allocationPolicy o meno per un determinato hub iot.	Bool
connectionString	Stringa di connessione dell'hub IoT.	stringa (obbligatorio)
ubicazione	Area arm dell'hub IoT.	stringa (obbligatorio)

IpFilterRule

Nome	Descrizione	Valore
azione	Azione desiderata per le richieste acquisite da questa regola.	'Accept' 'Reject' (obbligatorio)
filterName	Nome della regola di filtro IP.	stringa (obbligatorio)
ipMask	Stringa che contiene l'intervallo di indirizzi IP nella notazione CIDR per la regola.	stringa (obbligatorio)
bersaglio	Destinazione per le richieste acquisite da questa regola.	'all' 'deviceApi' 'serviceApi'

Microsoft.Devices/provisioningServices

Nome	Descrizione	Valore
apiVersion	Versione dell'API	'2021-10-15'
etag	Il campo Etag è non obbligatorio. Se viene specificato nel corpo della risposta, deve anche essere fornito come intestazione in base alla normale convenzione ETag.	corda
ubicazione	Percorso della risorsa.	stringa (obbligatorio)
nome	Nome della risorsa	stringa (obbligatorio)
proprietà	Proprietà specifiche del servizio per un servizio di provisioning	IotDpsPropertiesDescription (obbligatorio)
Sku	Informazioni sullo SKU per un servizio di provisioning.	IotDpsSkuInfo (obbligatorio)
Tag	Tag delle risorse	Dizionario di nomi e valori di tag. Vedere tag nei modelli
digitare	Tipo di risorsa	'Microsoft.Devices/provisioningServices'

PrivateEndpoint

Nome	Descrizione	Valore

PrivateEndpointConnection

Nome	Descrizione	Valore
proprietà	Proprietà di una connessione endpoint privato	PrivateEndpointConnectionProperties (obbligatorio)

PrivateEndpointConnectionProperties

Nome	Descrizione	Valore
privateEndpoint	Proprietà dell'endpoint privato di una connessione endpoint privato	PrivateEndpoint
privateLinkServiceConnectionState	Stato corrente di una connessione endpoint privato	PrivateLinkServiceConnectionState (obbligatorio)

PrivateLinkServiceConnectionState

Nome	Descrizione	Valore
actionsRequired	Azioni necessarie per una connessione all'endpoint privato	corda
descrizione	Descrizione dello stato corrente di una connessione endpoint privato	stringa (obbligatorio)
stato	Stato di una connessione endpoint privato	'Approvato' 'Disconnesso' 'In sospeso' 'Rejected' (obbligatorio)

ResourceTags

Nome	Descrizione	Valore

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Nome	Descrizione	Valore
keyName	Nome della chiave.	stringa (obbligatorio)
primaryKey	Valore della chiave di firma di accesso condiviso primario.	corda
diritti	Diritti di cui dispone la chiave.	'DeviceConnect' 'EnrollmentRead' 'EnrollmentWrite' 'RegistrationStatusRead' 'RegistrationStatusWrite' 'ServiceConfig' (obbligatorio)
secondaryKey	Valore della chiave di firma di accesso condiviso secondario.	corda

Modelli di avvio rapido

I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Sagoma	Descrizione
Creare un hub IOT e un simulatore perimetrale Ubuntu	Questo modello crea un hub IOT e un simulatore perimetrale Ubuntu della macchina virtuale.
Creare un servizio Device Provisioning in hub IoT	Questo modello consente di creare un hub IoT e un servizio Device Provisioning in hub IoT e collegare i due servizi.

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa provisioningServices può essere distribuito con operazioni destinate a:

gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.Devices/provisioningServices, aggiungere il codice Terraform seguente al modello.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Devices/provisioningServices@2021-10-15"
  name = "string"
  etag = "string"
  location = "string"
  sku = {
    capacity = int
    name = "string"
  }
  tags = {
    {customized property} = "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"
        }
      ]
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {
            }
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
          }
        }
      ]
      provisioningState = "string"
      publicNetworkAccess = "string"
      state = "string"
    }
  })
}

Valori delle proprietà

IotDpsPropertiesDescription

Nome	Descrizione	Valore
allocationPolicy	Criteri di allocazione da usare da questo servizio di provisioning.	'GeoLatency' 'Hashed' 'Static'
authorizationPolicies	Elenco delle chiavi di autorizzazione per un servizio di provisioning.	SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]
enableDataResidency	Opzionale. Indica se l'istanza del servizio Device Provisioning ha la residenza dei dati abilitata, rimuovendo il ripristino di emergenza tra coppie geografiche.	Bool
iotHubs	Elenco degli hub IoT associati a questo servizio di provisioning.	IotHubDefinitionDescription[]
ipFilterRules	Regole di filtro IP.	IpFilterRule[]
privateEndpointConnections	Connessioni endpoint private create in questo IotHub	PrivateEndpointConnection[]
provisioningState	Stato di provisioning arm del servizio di provisioning.	corda
publicNetworkAccess	Indica se le richieste dalla rete pubblica sono consentite	'Disabilitato' 'Enabled'
stato	Stato corrente del servizio di provisioning.	'Attivazione' 'ActivationFailed' 'Attivo' 'Eliminato' 'Eliminazione' 'DeletionFailed' 'FailOver' 'FailoverFailed' 'Ripresa' 'Sospeso' 'Suspending' 'Transizione'

IotDpsSkuInfo

Nome	Descrizione	Valore
capacità	Numero di unità di cui effettuare il provisioning	Int
nome	Nome sku.	'S1'

IotHubDefinitionDescription

Nome	Descrizione	Valore
allocationWeight	peso da applicare per un determinato iot h.	Int
applyAllocationPolicy	flag per l'applicazione di allocationPolicy o meno per un determinato hub iot.	Bool
connectionString	Stringa di connessione dell'hub IoT.	stringa (obbligatorio)
ubicazione	Area arm dell'hub IoT.	stringa (obbligatorio)

IpFilterRule

Nome	Descrizione	Valore
azione	Azione desiderata per le richieste acquisite da questa regola.	'Accept' 'Reject' (obbligatorio)
filterName	Nome della regola di filtro IP.	stringa (obbligatorio)
ipMask	Stringa che contiene l'intervallo di indirizzi IP nella notazione CIDR per la regola.	stringa (obbligatorio)
bersaglio	Destinazione per le richieste acquisite da questa regola.	'all' 'deviceApi' 'serviceApi'

Microsoft.Devices/provisioningServices

Nome	Descrizione	Valore
etag	Il campo Etag è non obbligatorio. Se viene specificato nel corpo della risposta, deve anche essere fornito come intestazione in base alla normale convenzione ETag.	corda
ubicazione	Percorso della risorsa.	stringa (obbligatorio)
nome	Nome della risorsa	stringa (obbligatorio)
proprietà	Proprietà specifiche del servizio per un servizio di provisioning	IotDpsPropertiesDescription (obbligatorio)
Sku	Informazioni sullo SKU per un servizio di provisioning.	IotDpsSkuInfo (obbligatorio)
Tag	Tag delle risorse	Dizionario di nomi e valori di tag.
digitare	Tipo di risorsa	"Microsoft.Devices/provisioningServices@2021-10-15"

PrivateEndpoint

Nome	Descrizione	Valore

PrivateEndpointConnection

Nome	Descrizione	Valore
proprietà	Proprietà di una connessione endpoint privato	PrivateEndpointConnectionProperties (obbligatorio)

PrivateEndpointConnectionProperties

Nome	Descrizione	Valore
privateEndpoint	Proprietà dell'endpoint privato di una connessione endpoint privato	PrivateEndpoint
privateLinkServiceConnectionState	Stato corrente di una connessione endpoint privato	PrivateLinkServiceConnectionState (obbligatorio)

PrivateLinkServiceConnectionState

Nome	Descrizione	Valore
actionsRequired	Azioni necessarie per una connessione all'endpoint privato	corda
descrizione	Descrizione dello stato corrente di una connessione endpoint privato	stringa (obbligatorio)
stato	Stato di una connessione endpoint privato	'Approvato' 'Disconnesso' 'In sospeso' 'Rejected' (obbligatorio)

ResourceTags

Nome	Descrizione	Valore

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Nome	Descrizione	Valore
keyName	Nome della chiave.	stringa (obbligatorio)
primaryKey	Valore della chiave di firma di accesso condiviso primario.	corda
diritti	Diritti di cui dispone la chiave.	'DeviceConnect' 'EnrollmentRead' 'EnrollmentWrite' 'RegistrationStatusRead' 'RegistrationStatusWrite' 'ServiceConfig' (obbligatorio)
secondaryKey	Valore della chiave di firma di accesso condiviso secondario.	corda

Condividi tramite

Microsoft.Devices provisioningServices 2021-10-15

Definizione di risorsa Bicep

Formato risorsa

Valori delle proprietà

IotDpsPropertiesDescription

IotDpsSkuInfo

IotHubDefinitionDescription

IpFilterRule

Microsoft.Devices/provisioningServices

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

ResourceTags

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Esempi di avvio rapido

Definizione di risorsa del modello di Resource Manager

Formato risorsa

Valori delle proprietà

IotDpsPropertiesDescription

IotDpsSkuInfo

IotHubDefinitionDescription

IpFilterRule

Microsoft.Devices/provisioningServices

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

ResourceTags

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Modelli di avvio rapido

Definizione di risorsa Terraform (provider AzAPI)

Formato risorsa

Valori delle proprietà

IotDpsPropertiesDescription

IotDpsSkuInfo

IotHubDefinitionDescription

IpFilterRule

Microsoft.Devices/provisioningServices

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

ResourceTags

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Commenti e suggerimenti

Risorse aggiuntive