Partilhar via


Microsoft.IoTCentral iotApps

Definição de recursos do bíceps

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

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

Formato do recurso

Para criar um recurso Microsoft.IoTCentral/iotApps, adicione o seguinte Bicep ao seu 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

Designação Descrição Valor
identidade As identidades gerenciadas para o aplicativo IoT Central. SystemAssignedServiceIdentity
localização A geolocalização onde o recurso vive string (obrigatório)
Designação O nome do recurso string (obrigatório)
propriedades As propriedades comuns de um aplicativo IoT Central. AppProperties
âmbito 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 instância válida SKU. AppSkuInfo (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos

AppProperties

Designação Descrição Valor
nome de exibição O nome para exibição do aplicativo. cadeia (de caracteres)
networkRuleSets Propriedades do conjunto de regras de rede deste aplicativo IoT Central. NetworkRuleSets
acesso à rede pública Se as solicitações da rede pública são permitidas. 'Desativado'
'Habilitado'
subdomínio O subdomínio do aplicativo. cadeia (de caracteres)
modelo A ID do modelo de aplicativo, que é um esquema que define as características e comportamentos de um aplicativo. Opcional; Se não for especificado, o padrão é um esquema em branco e permite que o aplicativo seja definido do zero. cadeia (de caracteres)

AppSkuInfo

Designação Descrição Valor
Designação O nome do SKU. «ST0»
«ST1»
«ST2» (obrigatório)

NetworkRuleSetIpRule

Designação Descrição Valor
filterName O nome legível da regra IP. cadeia (de caracteres)
ipMask O bloco CIDR que define o intervalo de IP. cadeia (de caracteres)

NetworkRuleSets

Designação Descrição Valor
applyToDevices Se essas regras se aplicam à conectividade do dispositivo ao Hub IoT e ao serviço de Provisionamento de Dispositivo associado a este aplicativo. Bool
applyToIoTCentral Se essas regras se aplicam à conectividade via portal da Web e APIs do IoT Central. Bool
defaultAction A ação de rede padrão a ser aplicada. 'Permitir'
'Negar'
ipRegras Lista de regras de PI. NetworkRuleSetIpRule[]

SystemAssignedServiceIdentity

Designação Descrição Valor
tipo Tipo de identidade de serviço gerenciado (sistema atribuído ou nenhum). 'Nenhuma'
'SystemAssigned' (obrigatório)

TrackedResourceTags

Designação Descrição Valor

Definição de recurso de modelo ARM

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

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

Formato do recurso

Para criar um recurso Microsoft.IoTCentral/iotApps, adicione o seguinte JSON ao seu 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

Designação Descrição Valor
Versão da API A versão api '2021-11-01-pré-visualização'
identidade As identidades gerenciadas para o aplicativo IoT Central. SystemAssignedServiceIdentity
localização A geolocalização onde o recurso vive string (obrigatório)
Designação O nome do recurso string (obrigatório)
propriedades As propriedades comuns de um aplicativo IoT Central. AppProperties
SKU Uma instância válida SKU. AppSkuInfo (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo O tipo de recurso 'Microsoft.IoTCentral/iotApps'

AppProperties

Designação Descrição Valor
nome de exibição O nome para exibição do aplicativo. cadeia (de caracteres)
networkRuleSets Propriedades do conjunto de regras de rede deste aplicativo IoT Central. NetworkRuleSets
acesso à rede pública Se as solicitações da rede pública são permitidas. 'Desativado'
'Habilitado'
subdomínio O subdomínio do aplicativo. cadeia (de caracteres)
modelo A ID do modelo de aplicativo, que é um esquema que define as características e comportamentos de um aplicativo. Opcional; Se não for especificado, o padrão é um esquema em branco e permite que o aplicativo seja definido do zero. cadeia (de caracteres)

AppSkuInfo

Designação Descrição Valor
Designação O nome do SKU. «ST0»
«ST1»
«ST2» (obrigatório)

NetworkRuleSetIpRule

Designação Descrição Valor
filterName O nome legível da regra IP. cadeia (de caracteres)
ipMask O bloco CIDR que define o intervalo de IP. cadeia (de caracteres)

NetworkRuleSets

Designação Descrição Valor
applyToDevices Se essas regras se aplicam à conectividade do dispositivo ao Hub IoT e ao serviço de Provisionamento de Dispositivo associado a este aplicativo. Bool
applyToIoTCentral Se essas regras se aplicam à conectividade via portal da Web e APIs do IoT Central. Bool
defaultAction A ação de rede padrão a ser aplicada. 'Permitir'
'Negar'
ipRegras Lista de regras de PI. NetworkRuleSetIpRule[]

SystemAssignedServiceIdentity

Designação Descrição Valor
tipo Tipo de identidade de serviço gerenciado (sistema atribuído ou nenhum). 'Nenhuma'
'SystemAssigned' (obrigatório)

TrackedResourceTags

Designação Descrição Valor

Exemplos de uso

Definição de recursos Terraform (provedor AzAPI)

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

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

Formato do recurso

Para criar um recurso Microsoft.IoTCentral/iotApps, adicione o seguinte Terraform 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

Designação Descrição Valor
identidade As identidades gerenciadas para o aplicativo IoT Central. SystemAssignedServiceIdentity
localização A geolocalização onde o recurso vive string (obrigatório)
Designação O nome do recurso string (obrigatório)
parent_id A ID do recurso ao qual aplicar esse recurso de extensão. string (obrigatório)
propriedades As propriedades comuns de um aplicativo IoT Central. AppProperties
SKU Uma instância válida SKU. AppSkuInfo (obrigatório)
Etiquetas Tags de recursos Dicionário de nomes e valores de tags.
tipo O tipo de recurso "Microsoft.IoTCentral/iotApps@2021-11-01-preview"

AppProperties

Designação Descrição Valor
nome de exibição O nome para exibição do aplicativo. cadeia (de caracteres)
networkRuleSets Propriedades do conjunto de regras de rede deste aplicativo IoT Central. NetworkRuleSets
acesso à rede pública Se as solicitações da rede pública são permitidas. 'Desativado'
'Habilitado'
subdomínio O subdomínio do aplicativo. cadeia (de caracteres)
modelo A ID do modelo de aplicativo, que é um esquema que define as características e comportamentos de um aplicativo. Opcional; Se não for especificado, o padrão é um esquema em branco e permite que o aplicativo seja definido do zero. cadeia (de caracteres)

AppSkuInfo

Designação Descrição Valor
Designação O nome do SKU. «ST0»
«ST1»
«ST2» (obrigatório)

NetworkRuleSetIpRule

Designação Descrição Valor
filterName O nome legível da regra IP. cadeia (de caracteres)
ipMask O bloco CIDR que define o intervalo de IP. cadeia (de caracteres)

NetworkRuleSets

Designação Descrição Valor
applyToDevices Se essas regras se aplicam à conectividade do dispositivo ao Hub IoT e ao serviço de Provisionamento de Dispositivo associado a este aplicativo. Bool
applyToIoTCentral Se essas regras se aplicam à conectividade via portal da Web e APIs do IoT Central. Bool
defaultAction A ação de rede padrão a ser aplicada. 'Permitir'
'Negar'
ipRegras Lista de regras de PI. NetworkRuleSetIpRule[]

SystemAssignedServiceIdentity

Designação Descrição Valor
tipo Tipo de identidade de serviço gerenciado (sistema atribuído ou nenhum). 'Nenhuma'
'SystemAssigned' (obrigatório)

TrackedResourceTags

Designação Descrição Valor

Exemplos de uso

Amostras Terraform

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

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    = ["*"]
}