Compartilhar via


Microsoft.IoTCentral iotApps

Definição de recurso do Bicep

O tipo de recurso iotApps pode ser implantado com operações de destino:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.IoTCentral/iotApps, adicione o Bicep a seguir ao modelo.

resource symbolicname 'Microsoft.IoTCentral/iotApps@2021-11-01-preview' = {
  scope: resourceSymbolicName or scope
  identity: {
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    displayName: 'string'
    networkRuleSets: {
      applyToDevices: bool
      applyToIoTCentral: bool
      defaultAction: 'string'
      ipRules: [
        {
          filterName: 'string'
          ipMask: 'string'
        }
      ]
    }
    publicNetworkAccess: 'string'
    subdomain: 'string'
    template: 'string'
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

Microsoft.IoTCentral/iotApps

Nome Descrição Valor
identidade As identidades gerenciadas para o aplicativo IoT Central. SystemAssignedServiceIdentity
local A localização geográfica onde o recurso reside cadeia de caracteres (obrigatório)
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades As propriedades comuns de um aplicativo do IoT Central. Propriedades do aplicativo
escopo Use ao criar um recurso em um escopo diferente do escopo de implantação. Defina essa propriedade como o nome simbólico de um recurso para aplicar o recurso de extensão .
Sku Uma SKU de instância válida. AppSkuInfo (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos

Propriedades do aplicativo

Nome Descrição Valor
nome de exibição O nome de exibição do aplicativo. cadeia
networkRuleSets Propriedades do conjunto de regras de rede deste aplicativo do IoT Central. NetworkRuleSets
públicoAcessoRedeAcesso Se as solicitações da rede pública são permitidas. 'Desabilitado'
'Habilitado'
subdomínio O subdomínio do aplicativo. cadeia
modelo A ID do modelo de aplicativo, que é um blueprint que define as características e comportamentos de um aplicativo. Opcional; se não for especificado, o padrão será um blueprint em branco e permitirá que o aplicativo seja definido do zero. cadeia

AppSkuInfo

Nome Descrição Valor
nome O nome da SKU. 'ST0'
'ST1'
'ST2' (obrigatório)

NetworkRuleSetIpRule

Nome Descrição Valor
filterName O nome legível da regra de IP. cadeia
Máscara de ip O bloco CIDR que define o intervalo de IP. cadeia

Conjuntos de regras de rede

Nome Descrição Valor
applyToDevices Se essas regras se aplicam à conectividade do dispositivo ao Hub IoT e ao serviço de Provisionamento de Dispositivos associados a esse aplicativo. Bool
applyToIoTCentral Se essas regras se aplicam à conectividade por meio do portal da Web do IoT Central e das APIs. Bool
defaultAction A ação de rede padrão a ser aplicada. 'Permitir'
'Negar'
ipRules Lista de regras de IP. NetworkRuleSetIpRule []

SystemAssignedServiceIdentity

Nome Descrição Valor
tipo Tipo de identidade de serviço gerenciada (atribuída pelo sistema ou nenhuma). 'Nenhum'
'SystemAssigned' (obrigatório)

TrackedResourceTags

Nome Descrição Valor

Definição de recurso de modelo do ARM

O tipo de recurso iotApps pode ser implantado com operações de destino:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.IoTCentral/iotApps, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.IoTCentral/iotApps",
  "apiVersion": "2021-11-01-preview",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "string",
  "properties": {
    "displayName": "string",
    "networkRuleSets": {
      "applyToDevices": "bool",
      "applyToIoTCentral": "bool",
      "defaultAction": "string",
      "ipRules": [
        {
          "filterName": "string",
          "ipMask": "string"
        }
      ]
    },
    "publicNetworkAccess": "string",
    "subdomain": "string",
    "template": "string"
  },
  "sku": {
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

Microsoft.IoTCentral/iotApps

Nome Descrição Valor
apiVersion A versão da API '2021-11-01-preview'
identidade As identidades gerenciadas para o aplicativo IoT Central. SystemAssignedServiceIdentity
local A localização geográfica onde o recurso reside cadeia de caracteres (obrigatório)
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades As propriedades comuns de um aplicativo do IoT Central. Propriedades do aplicativo
Sku Uma SKU de instância válida. AppSkuInfo (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos
tipo O tipo de recurso 'Microsoft.IoTCentral/iotApps'

Propriedades do aplicativo

Nome Descrição Valor
nome de exibição O nome de exibição do aplicativo. cadeia
networkRuleSets Propriedades do conjunto de regras de rede deste aplicativo do IoT Central. NetworkRuleSets
públicoAcessoRedeAcesso Se as solicitações da rede pública são permitidas. 'Desabilitado'
'Habilitado'
subdomínio O subdomínio do aplicativo. cadeia
modelo A ID do modelo de aplicativo, que é um blueprint que define as características e comportamentos de um aplicativo. Opcional; se não for especificado, o padrão será um blueprint em branco e permitirá que o aplicativo seja definido do zero. cadeia

AppSkuInfo

Nome Descrição Valor
nome O nome da SKU. 'ST0'
'ST1'
'ST2' (obrigatório)

NetworkRuleSetIpRule

Nome Descrição Valor
filterName O nome legível da regra de IP. cadeia
Máscara de ip O bloco CIDR que define o intervalo de IP. cadeia

Conjuntos de regras de rede

Nome Descrição Valor
applyToDevices Se essas regras se aplicam à conectividade do dispositivo ao Hub IoT e ao serviço de Provisionamento de Dispositivos associados a esse aplicativo. Bool
applyToIoTCentral Se essas regras se aplicam à conectividade por meio do portal da Web do IoT Central e das APIs. Bool
defaultAction A ação de rede padrão a ser aplicada. 'Permitir'
'Negar'
ipRules Lista de regras de IP. NetworkRuleSetIpRule []

SystemAssignedServiceIdentity

Nome Descrição Valor
tipo Tipo de identidade de serviço gerenciada (atribuída pelo sistema ou nenhuma). 'Nenhum'
'SystemAssigned' (obrigatório)

TrackedResourceTags

Nome Descrição Valor

Exemplos de uso

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso iotApps pode ser implantado com operações de destino:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.IoTCentral/iotApps, adicione o Terraform a seguir ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.IoTCentral/iotApps@2021-11-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      displayName = "string"
      networkRuleSets = {
        applyToDevices = bool
        applyToIoTCentral = bool
        defaultAction = "string"
        ipRules = [
          {
            filterName = "string"
            ipMask = "string"
          }
        ]
      }
      publicNetworkAccess = "string"
      subdomain = "string"
      template = "string"
    }
    sku = {
      name = "string"
    }
  }
}

Valores de propriedade

Microsoft.IoTCentral/iotApps

Nome Descrição Valor
identidade As identidades gerenciadas para o aplicativo IoT Central. SystemAssignedServiceIdentity
local A localização geográfica onde o recurso reside cadeia de caracteres (obrigatório)
nome O nome do recurso cadeia de caracteres (obrigatório)
parent_id A ID do recurso ao qual aplicar esse recurso de extensão. cadeia de caracteres (obrigatório)
Propriedades As propriedades comuns de um aplicativo do IoT Central. Propriedades do aplicativo
Sku Uma SKU de instância válida. AppSkuInfo (obrigatório)
Tags Marcas de recurso Dicionário de nomes e valores de marca.
tipo O tipo de recurso "Microsoft.IoTCentral/iotApps@2021-11-01-preview"

Propriedades do aplicativo

Nome Descrição Valor
nome de exibição O nome de exibição do aplicativo. cadeia
networkRuleSets Propriedades do conjunto de regras de rede deste aplicativo do IoT Central. NetworkRuleSets
públicoAcessoRedeAcesso Se as solicitações da rede pública são permitidas. 'Desabilitado'
'Habilitado'
subdomínio O subdomínio do aplicativo. cadeia
modelo A ID do modelo de aplicativo, que é um blueprint que define as características e comportamentos de um aplicativo. Opcional; se não for especificado, o padrão será um blueprint em branco e permitirá que o aplicativo seja definido do zero. cadeia

AppSkuInfo

Nome Descrição Valor
nome O nome da SKU. 'ST0'
'ST1'
'ST2' (obrigatório)

NetworkRuleSetIpRule

Nome Descrição Valor
filterName O nome legível da regra de IP. cadeia
Máscara de ip O bloco CIDR que define o intervalo de IP. cadeia

Conjuntos de regras de rede

Nome Descrição Valor
applyToDevices Se essas regras se aplicam à conectividade do dispositivo ao Hub IoT e ao serviço de Provisionamento de Dispositivos associados a esse aplicativo. Bool
applyToIoTCentral Se essas regras se aplicam à conectividade por meio do portal da Web do IoT Central e das APIs. Bool
defaultAction A ação de rede padrão a ser aplicada. 'Permitir'
'Negar'
ipRules Lista de regras de IP. NetworkRuleSetIpRule []

SystemAssignedServiceIdentity

Nome Descrição Valor
tipo Tipo de identidade de serviço gerenciada (atribuída pelo sistema ou nenhuma). 'Nenhum'
'SystemAssigned' (obrigatório)

TrackedResourceTags

Nome Descrição Valor

Exemplos de uso

Exemplos do Terraform

Um exemplo básico de implantação do aplicativo IotCentral.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "iotApp" {
  type      = "Microsoft.IoTCentral/iotApps@2021-11-01-preview"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      displayName         = var.resource_name
      publicNetworkAccess = "Enabled"
      subdomain           = "subdomain-2306300333537"
      template            = "iotc-pnp-preview@1.0.0"
    }
    sku = {
      name = "ST1"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}