Microsoft.Devices provisioningServices 2020-03-01

Bicep-resourcedefinitie

Het resourcetype provisioningServices kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.Devices/provisioningServices-resource wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

resource symbolicname 'Microsoft.Devices/provisioningServices@2020-03-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'
      }
    ]
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
        }
      }
    ]
    provisioningState: 'string'
    publicNetworkAccess: 'string'
    state: 'string'
  }
}

Eigenschapswaarden

provisioningServices

Naam Description Waarde
naam De resourcenaam tekenreeks (vereist)

Tekenlimiet: 3-64

Geldige tekens:
Alfanumerieken en afbreekstreepjes.

Eindig met alfanumeriek.
location De resourcelocatie. tekenreeks (vereist)
tags De resourcetags. Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken
sku SKU-informatie voor een inrichtingsservice. IotDpsSkuInfo (vereist)
etag Het veld Etag is niet vereist. Als deze is opgegeven in de hoofdtekst van het antwoord, moet deze ook worden opgegeven als een header volgens de normale ETag-conventie. tekenreeks
properties Servicespecifieke eigenschappen voor een inrichtingsservice IotDpsPropertiesDescription (vereist)

IotDpsPropertiesDescription

Naam Description Waarde
allocationPolicy Toewijzingsbeleid dat moet worden gebruikt door deze inrichtingsservice. 'GeoLatency'
'Gehasht'
Statisch
authorizationPolicies Lijst met autorisatiesleutels voor een inrichtingsservice. SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
iotHubs Lijst met IoT-hubs die zijn gekoppeld aan deze inrichtingsservice. IotHubDefinitionDescription[]
ipFilterRules De IP-filterregels. IpFilterRule[]
privateEndpointConnections Privé-eindpuntverbindingen die zijn gemaakt op deze IotHub PrivateEndpointConnection[]
provisioningState De ARM-inrichtingsstatus van de inrichtingsservice. tekenreeks
publicNetworkAccess Of aanvragen van het openbare netwerk zijn toegestaan 'Uitgeschakeld'
Ingeschakeld
staat Huidige status van de inrichtingsservice. 'Activeren'
'ActivationFailed'
'Actief'
'Verwijderd'
'Verwijderen'
'DeletionFailed'
'FailOver'
FailoverFailed
'Hervatten'
'Opgeschort'
'Onderbreken'
'Overgang'

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

Naam Description Waarde
keyName Naam van de sleutel. tekenreeks (vereist)
primaryKey Waarde van primaire SAS-sleutel. tekenreeks
Rechten Rechten die deze sleutel heeft. 'DeviceConnect'
'EnrollmentRead'
'EnrollmentWrite'
'RegistrationStatusRead'
'RegistrationStatusWrite'
ServiceConfig (vereist)
secondaryKey Waarde van secundaire SAS-sleutel. tekenreeks
keyName Naam van de sleutel. tekenreeks (vereist)
primaryKey Waarde van primaire SAS-sleutel. tekenreeks
Rechten Rechten die deze sleutel heeft. 'DeviceConnect'
'EnrollmentRead'
'EnrollmentWrite'
'RegistrationStatusRead'
'RegistrationStatusWrite'
ServiceConfig (vereist)
secondaryKey Waarde van secundaire SAS-sleutel. tekenreeks

IotHubDefinitionDescription

Naam Description Waarde
allocationWeight gewicht toe te passen voor een bepaalde iot h. int
applyAllocationPolicy vlag voor het toepassen van allocationPolicy of niet voor een bepaalde ioT-hub. booleaans
connectionString Verbindingsreeks van de IoT-hub. tekenreeks (vereist)
location ARM-regio van de IoT-hub. tekenreeks (vereist)

IpFilterRule

Naam Description Waarde
action De gewenste actie voor aanvragen die met deze regel zijn vastgelegd. 'Accepteren'
'Weigeren' (vereist)
filterName De naam van de IP-filterregel. tekenreeks (vereist)
ipMask Een tekenreeks die het IP-adresbereik in CIDR-notatie voor de regel bevat. tekenreeks (vereist)
Doel Doel voor aanvragen die zijn vastgelegd met deze regel. 'alle'
'deviceApi'
'serviceApi'

PrivateEndpointConnection

Naam Description Waarde
properties De eigenschappen van een privé-eindpuntverbinding PrivateEndpointConnectionProperties (vereist)

PrivateEndpointConnectionProperties

Naam Description Waarde
privateEndpoint De privé-eindpunteigenschap van een privé-eindpuntverbinding PrivateEndpoint
privateLinkServiceConnectionState De huidige status van een privé-eindpuntverbinding PrivateLinkServiceConnectionState (vereist)

PrivateEndpoint

Dit object bevat geen eigenschappen die tijdens de implementatie moeten worden ingesteld. Alle eigenschappen zijn ReadOnly.

PrivateLinkServiceConnectionState

Naam Description Waarde
actionsRequired Vereiste acties voor een privé-eindpuntverbinding tekenreeks
beschrijving De beschrijving voor de huidige status van een privé-eindpuntverbinding tekenreeks (vereist)
status De status van een privé-eindpuntverbinding 'Goedgekeurd'
'Verbinding verbroken'
'In behandeling'
'Geweigerd' (vereist)

IotDpsSkuInfo

Naam Description Waarde
capacity Het aantal eenheden dat moet worden ingericht int
naam SKU-naam. 'S1'

Snelstartsjablonen

Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.

Template Beschrijving
Een IOT Hub- en Ubuntu Edge-simulator maken

Implementeren op Azure
Met deze sjabloon maakt u een IOT-hub en virtuele machine Ubuntu Edge-simulator.
Een IoT Hub Device Provisioning Service maken

Implementeren op Azure
Met deze sjabloon kunt u een IoT-hub en een IoT Hub Device Provisioning Service maken en de twee services aan elkaar koppelen.

Resourcedefinitie van ARM-sjabloon

Het resourcetype provisioningServices kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource Microsoft.Devices/provisioningServices wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.Devices/provisioningServices",
  "apiVersion": "2020-03-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"
      }
    ],
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {},
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          }
        }
      }
    ],
    "provisioningState": "string",
    "publicNetworkAccess": "string",
    "state": "string"
  }
}

Eigenschapswaarden

provisioningServices

Naam Description Waarde
type Het resourcetype 'Microsoft.Devices/provisioningServices'
apiVersion De resource-API-versie '2020-03-01'
naam De resourcenaam tekenreeks (vereist)

Tekenlimiet: 3-64

Geldige tekens:
Alfanumeriek en afbreekstreepjes.

Eindig met alfanumeriek.
location De resourcelocatie. tekenreeks (vereist)
tags De resourcetags. Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken
sku SKU-informatie voor een inrichtingsservice. IotDpsSkuInfo (vereist)
etag Het veld Etag is niet vereist. Als deze is opgegeven in de hoofdtekst van het antwoord, moet deze ook worden opgegeven als een header volgens de normale ETag-conventie. tekenreeks
properties Servicespecifieke eigenschappen voor een inrichtingsservice IotDpsPropertiesDescription (vereist)

IotDpsPropertiesDescription

Naam Description Waarde
allocationPolicy Toewijzingsbeleid dat moet worden gebruikt door deze inrichtingsservice. 'GeoLatency'
'Gehasht'
Statisch
authorizationPolicies Lijst met autorisatiesleutels voor een inrichtingsservice. SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
iotHubs Lijst met IoT-hubs die zijn gekoppeld aan deze inrichtingsservice. IotHubDefinitionDescription[]
ipFilterRules De IP-filterregels. IpFilterRule[]
privateEndpointConnections Privé-eindpuntverbindingen die zijn gemaakt op deze IotHub PrivateEndpointConnection[]
provisioningState De ARM-inrichtingsstatus van de inrichtingsservice. tekenreeks
publicNetworkAccess Of aanvragen van het openbare netwerk zijn toegestaan 'Uitgeschakeld'
Ingeschakeld
staat Huidige status van de inrichtingsservice. 'Activeren'
'ActivationFailed'
'Actief'
'Verwijderd'
'Verwijderen'
'DeletionFailed'
'FailOver'
FailoverFailed
'Hervatten'
'Opgeschort'
'Onderbreken'
'Overgang'

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

Naam Description Waarde
keyName Naam van de sleutel. tekenreeks (vereist)
primaryKey Waarde van primaire SAS-sleutel. tekenreeks
Rechten Rechten die deze sleutel heeft. 'DeviceConnect'
'EnrollmentRead'
'EnrollmentWrite'
'RegistrationStatusRead'
'RegistrationStatusWrite'
ServiceConfig (vereist)
secondaryKey Waarde van secundaire SAS-sleutel. tekenreeks
keyName Naam van de sleutel. tekenreeks (vereist)
primaryKey Waarde van primaire SAS-sleutel. tekenreeks
Rechten Rechten die deze sleutel heeft. 'DeviceConnect'
'EnrollmentRead'
'EnrollmentWrite'
'RegistrationStatusRead'
'RegistrationStatusWrite'
ServiceConfig (vereist)
secondaryKey Waarde van secundaire SAS-sleutel. tekenreeks

IotHubDefinitionDescription

Naam Description Waarde
allocationWeight gewicht toe te passen voor een bepaalde iot h. int
applyAllocationPolicy vlag voor het toepassen van allocationPolicy of niet voor een bepaalde ioT-hub. booleaans
connectionString Verbindingsreeks van de IoT-hub. tekenreeks (vereist)
location ARM-regio van de IoT-hub. tekenreeks (vereist)

IpFilterRule

Naam Description Waarde
action De gewenste actie voor aanvragen die met deze regel zijn vastgelegd. 'Accepteren'
'Weigeren' (vereist)
filterName De naam van de IP-filterregel. tekenreeks (vereist)
ipMask Een tekenreeks die het IP-adresbereik in CIDR-notatie voor de regel bevat. tekenreeks (vereist)
Doel Doel voor aanvragen die zijn vastgelegd met deze regel. 'alle'
'deviceApi'
'serviceApi'

PrivateEndpointConnection

Naam Description Waarde
properties De eigenschappen van een privé-eindpuntverbinding PrivateEndpointConnectionProperties (vereist)

PrivateEndpointConnectionProperties

Naam Description Waarde
privateEndpoint De privé-eindpunteigenschap van een privé-eindpuntverbinding PrivateEndpoint
privateLinkServiceConnectionState De huidige status van een privé-eindpuntverbinding PrivateLinkServiceConnectionState (vereist)

PrivateEndpoint

Dit object bevat geen eigenschappen die tijdens de implementatie moeten worden ingesteld. Alle eigenschappen zijn ReadOnly.

PrivateLinkServiceConnectionState

Naam Description Waarde
actionsRequired Vereiste acties voor een privé-eindpuntverbinding tekenreeks
beschrijving De beschrijving voor de huidige status van een privé-eindpuntverbinding tekenreeks (vereist)
status De status van een privé-eindpuntverbinding 'Goedgekeurd'
'Verbinding verbroken'
'In behandeling'
'Geweigerd' (vereist)

IotDpsSkuInfo

Naam Description Waarde
capacity Het aantal eenheden dat moet worden ingericht int
naam SKU-naam. 'S1'

Snelstartsjablonen

Met de volgende snelstartsjablonen wordt dit resourcetype geïmplementeerd.

Template Beschrijving
Een IOT Hub- en Ubuntu Edge-simulator maken

Implementeren op Azure
Met deze sjabloon maakt u een IOT Hub en virtuele Machine Ubuntu Edge-simulator.
Een IoT Hub Device Provisioning Service maken

Implementeren op Azure
Met deze sjabloon kunt u een IoT-hub en een IoT Hub Device Provisioning Service maken en de twee services aan elkaar koppelen.

Terraform-resourcedefinitie (AzAPI-provider)

Het resourcetype provisioningServices kan worden geïmplementeerd met bewerkingen die zijn gericht op:

  • Resourcegroepen

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.Devices/provisioningServices-resource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

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

Eigenschapswaarden

provisioningServices

Naam Description Waarde
type Het resourcetype "Microsoft.Devices/provisioningServices@2020-03-01"
naam De resourcenaam tekenreeks (vereist)

Tekenlimiet: 3-64

Geldige tekens:
Alfanumerieken en afbreekstreepjes.

Eindig met alfanumeriek.
location De resourcelocatie. tekenreeks (vereist)
parent_id Als u wilt implementeren in een resourcegroep, gebruikt u de id van die resourcegroep. tekenreeks (vereist)
tags De resourcetags. Woordenlijst met tagnamen en -waarden.
sku SKU-informatie voor een inrichtingsservice. IotDpsSkuInfo (vereist)
etag Het veld Etag is niet vereist. Als deze is opgegeven in de hoofdtekst van het antwoord, moet deze ook worden opgegeven als een header volgens de normale ETag-conventie. tekenreeks
properties Servicespecifieke eigenschappen voor een inrichtingsservice IotDpsPropertiesDescription (vereist)

IotDpsPropertiesDescription

Naam Description Waarde
allocationPolicy Toewijzingsbeleid dat moet worden gebruikt door deze inrichtingsservice. "GeoLatency"
"Gehasht"
"Statisch"
authorizationPolicies Lijst met autorisatiesleutels voor een inrichtingsservice. SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
iotHubs Lijst met IoT-hubs die zijn gekoppeld aan deze inrichtingsservice. IotHubDefinitionDescription[]
ipFilterRules De IP-filterregels. IpFilterRule[]
privateEndpointConnections Privé-eindpuntverbindingen die zijn gemaakt op deze IotHub PrivateEndpointConnection[]
provisioningState De ARM-inrichtingsstatus van de inrichtingsservice. tekenreeks
publicNetworkAccess Of aanvragen van het openbare netwerk zijn toegestaan "Uitgeschakeld"
"Ingeschakeld"
staat Huidige status van de inrichtingsservice. "Activeren"
"ActivationFailed"
"Actief"
"Verwijderd"
"Verwijderen"
"DeletionFailed"
"FailOver"
"FailoverFailed"
"Hervatten"
"Opgeschort"
"Onderbreken"
"Overgang"

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

Naam Description Waarde
keyName Naam van de sleutel. tekenreeks (vereist)
primaryKey Waarde van primaire SAS-sleutel. tekenreeks
Rechten Rechten die deze sleutel heeft. "DeviceConnect"
"EnrollmentRead"
"EnrollmentWrite"
"RegistrationStatusRead"
"RegistrationStatusWrite"
"ServiceConfig" (vereist)
secondaryKey Waarde van secundaire SAS-sleutel. tekenreeks
keyName Naam van de sleutel. tekenreeks (vereist)
primaryKey Waarde van primaire SAS-sleutel. tekenreeks
Rechten Rechten die deze sleutel heeft. "DeviceConnect"
"EnrollmentRead"
"EnrollmentWrite"
"RegistrationStatusRead"
"RegistrationStatusWrite"
"ServiceConfig" (vereist)
secondaryKey Waarde van secundaire SAS-sleutel. tekenreeks

IotHubDefinitionDescription

Naam Description Waarde
allocationWeight gewicht toe te passen voor een bepaalde iot h. int
applyAllocationPolicy vlag voor het toepassen van allocationPolicy of niet voor een bepaalde IoT-hub. booleaans
connectionString Verbindingsreeks van de IoT-hub. tekenreeks (vereist)
location ARM-regio van de IoT-hub. tekenreeks (vereist)

IpFilterRule

Naam Description Waarde
action De gewenste actie voor aanvragen die door deze regel zijn vastgelegd. "Accepteren"
'Weigeren' (vereist)
filterName De naam van de IP-filterregel. tekenreeks (vereist)
ipMask Een tekenreeks die het IP-adresbereik bevat in CIDR-notatie voor de regel. tekenreeks (vereist)
Doel Doel voor aanvragen die door deze regel zijn vastgelegd. "alle"
"deviceApi"
"serviceApi"

PrivateEndpointConnection

Naam Description Waarde
properties De eigenschappen van een privé-eindpuntverbinding PrivateEndpointConnectionProperties (vereist)

PrivateEndpointConnectionProperties

Naam Description Waarde
privateEndpoint De privé-eindpunteigenschap van een privé-eindpuntverbinding PrivateEndpoint
privateLinkServiceConnectionState De huidige status van een privé-eindpuntverbinding PrivateLinkServiceConnectionState (vereist)

PrivateEndpoint

Dit object bevat geen eigenschappen die tijdens de implementatie moeten worden ingesteld. Alle eigenschappen zijn ReadOnly.

PrivateLinkServiceConnectionState

Naam Description Waarde
actionsRequired Vereiste acties voor een privé-eindpuntverbinding tekenreeks
beschrijving De beschrijving voor de huidige status van een privé-eindpuntverbinding tekenreeks (vereist)
status De status van een privé-eindpuntverbinding "Goedgekeurd"
"Verbinding verbroken"
"In behandeling"
'Geweigerd' (vereist)

IotDpsSkuInfo

Naam Description Waarde
capacity Het aantal eenheden dat moet worden ingericht int
naam SKU-naam. "S1"