Udostępnij przez


Microsoft.IoTCentral iotApps

Definicja zasobu Bicep

Typ zasobu iotApps można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.IoTCentral/iotApps, dodaj następujący kod Bicep do szablonu.

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'
  }
}

Wartości właściwości

Microsoft.IoTCentral/iotApps

Nazwa Opis Wartość
tożsamość Tożsamości zarządzane dla aplikacji usługi IoT Central. SystemAssignedServiceIdentity (tożsamość usługi)
lokalizacja Lokalizacja geograficzna, w której znajduje się zasób ciąg (wymagany)
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Typowe właściwości aplikacji usługi IoT Central. Właściwości aplikacji
zakres Użyj polecenia podczas tworzenia zasobu w zakresie innym niż zakres wdrożenia. Ustaw tę właściwość na symboliczną nazwę zasobu, aby zastosować zasób rozszerzenia.
Numer jednostki magazynowej Prawidłowa jednostka SKU wystąpienia. AppSkuInfo (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

Właściwości aplikacji

Nazwa Opis Wartość
nazwa wyświetlana Nazwa wyświetlana aplikacji. ciąg
networkRuleSets (zestawy reguł sieciowych) Właściwości zestawu reguł sieci dla tej aplikacji usługi IoT Central. Zestawy reguł sieciowychNetworkRuleSets
dostęp do sieci publicznej Czy żądania z sieci publicznej są dozwolone. "Wyłączone"
"Włączone"
poddomena Poddomena aplikacji. ciąg
szablon Identyfikator szablonu aplikacji, który jest strategią, która definiuje cechy i zachowania aplikacji. Fakultatywny; jeśli nie zostanie określony, domyślnie zostanie ustawiona pusta strategia i umożliwia zdefiniowanie aplikacji od podstaw. ciąg

AppSkuInfo (Informacje o aplikacji)

Nazwa Opis Wartość
nazwa Nazwa jednostki SKU. "ST0"
"ST1"
"ST2" (wymagane)

Reguła sieciowaSetIpRule

Nazwa Opis Wartość
nazwa_filtra Czytelna nazwa reguły adresu IP. ciąg
maska ip Blok CIDR definiujący zakres adresów IP. ciąg

Zestawy reguł sieciowychNetworkRuleSets

Nazwa Opis Wartość
applyToDevices (zastosuj się) Czy te reguły mają zastosowanie do łączności urządzeń z usługą IoT Hub i Device Provisioning skojarzona z tą aplikacją. Bool
applyToIoTCentral Czy te reguły mają zastosowanie do łączności za pośrednictwem portalu internetowego i interfejsów API usługi IoT Central. Bool
defaultAction (akcja domyślna) Domyślna akcja sieciowa do zastosowania. "Zezwalaj"
"Odmów"
Reguły ip Lista reguł adresów IP. Reguła SieciowaUstawionaIpReguła[]

SystemAssignedServiceIdentity (tożsamość usługi)

Nazwa Opis Wartość
typ Typ tożsamości usługi zarządzanej (przypisany system lub brak). "Brak"
"SystemAssigned" (wymagane)

Śledzone tagi zasobów

Nazwa Opis Wartość

Definicja zasobu szablonu usługi ARM

Typ zasobu iotApps można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.IoTCentral/iotApps, dodaj następujący kod JSON do szablonu.

{
  "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"
  }
}

Wartości właściwości

Microsoft.IoTCentral/iotApps

Nazwa Opis Wartość
apiVersion (wersja interfejsu api) Wersja interfejsu API "2021-11-01-preview"
tożsamość Tożsamości zarządzane dla aplikacji usługi IoT Central. SystemAssignedServiceIdentity (tożsamość usługi)
lokalizacja Lokalizacja geograficzna, w której znajduje się zasób ciąg (wymagany)
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Typowe właściwości aplikacji usługi IoT Central. Właściwości aplikacji
Numer jednostki magazynowej Prawidłowa jednostka SKU wystąpienia. AppSkuInfo (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ Typ zasobu "Microsoft.IoTCentral/iotApps"

Właściwości aplikacji

Nazwa Opis Wartość
nazwa wyświetlana Nazwa wyświetlana aplikacji. ciąg
networkRuleSets (zestawy reguł sieciowych) Właściwości zestawu reguł sieci dla tej aplikacji usługi IoT Central. Zestawy reguł sieciowychNetworkRuleSets
dostęp do sieci publicznej Czy żądania z sieci publicznej są dozwolone. "Wyłączone"
"Włączone"
poddomena Poddomena aplikacji. ciąg
szablon Identyfikator szablonu aplikacji, który jest strategią, która definiuje cechy i zachowania aplikacji. Fakultatywny; jeśli nie zostanie określony, domyślnie zostanie ustawiona pusta strategia i umożliwia zdefiniowanie aplikacji od podstaw. ciąg

AppSkuInfo (Informacje o aplikacji)

Nazwa Opis Wartość
nazwa Nazwa jednostki SKU. "ST0"
"ST1"
"ST2" (wymagane)

Reguła sieciowaSetIpRule

Nazwa Opis Wartość
nazwa_filtra Czytelna nazwa reguły adresu IP. ciąg
maska ip Blok CIDR definiujący zakres adresów IP. ciąg

Zestawy reguł sieciowychNetworkRuleSets

Nazwa Opis Wartość
applyToDevices (zastosuj się) Czy te reguły mają zastosowanie do łączności urządzeń z usługą IoT Hub i Device Provisioning skojarzona z tą aplikacją. Bool
applyToIoTCentral Czy te reguły mają zastosowanie do łączności za pośrednictwem portalu internetowego i interfejsów API usługi IoT Central. Bool
defaultAction (akcja domyślna) Domyślna akcja sieciowa do zastosowania. "Zezwalaj"
"Odmów"
Reguły ip Lista reguł adresów IP. Reguła SieciowaUstawionaIpReguła[]

SystemAssignedServiceIdentity (tożsamość usługi)

Nazwa Opis Wartość
typ Typ tożsamości usługi zarządzanej (przypisany system lub brak). "Brak"
"SystemAssigned" (wymagane)

Śledzone tagi zasobów

Nazwa Opis Wartość

Przykłady użycia

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu iotApps można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.IoTCentral/iotApps, dodaj następujący program Terraform do szablonu.

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"
    }
  }
}

Wartości właściwości

Microsoft.IoTCentral/iotApps

Nazwa Opis Wartość
tożsamość Tożsamości zarządzane dla aplikacji usługi IoT Central. SystemAssignedServiceIdentity (tożsamość usługi)
lokalizacja Lokalizacja geograficzna, w której znajduje się zasób ciąg (wymagany)
nazwa Nazwa zasobu ciąg (wymagany)
parent_id Identyfikator zasobu, do który ma być stosowany ten zasób rozszerzenia. ciąg (wymagany)
Właściwości Typowe właściwości aplikacji usługi IoT Central. Właściwości aplikacji
Numer jednostki magazynowej Prawidłowa jednostka SKU wystąpienia. AppSkuInfo (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft.IoTCentral/iotApps@2021-11-01-preview"

Właściwości aplikacji

Nazwa Opis Wartość
nazwa wyświetlana Nazwa wyświetlana aplikacji. ciąg
networkRuleSets (zestawy reguł sieciowych) Właściwości zestawu reguł sieci dla tej aplikacji usługi IoT Central. Zestawy reguł sieciowychNetworkRuleSets
dostęp do sieci publicznej Czy żądania z sieci publicznej są dozwolone. "Wyłączone"
"Włączone"
poddomena Poddomena aplikacji. ciąg
szablon Identyfikator szablonu aplikacji, który jest strategią, która definiuje cechy i zachowania aplikacji. Fakultatywny; jeśli nie zostanie określony, domyślnie zostanie ustawiona pusta strategia i umożliwia zdefiniowanie aplikacji od podstaw. ciąg

AppSkuInfo (Informacje o aplikacji)

Nazwa Opis Wartość
nazwa Nazwa jednostki SKU. "ST0"
"ST1"
"ST2" (wymagane)

Reguła sieciowaSetIpRule

Nazwa Opis Wartość
nazwa_filtra Czytelna nazwa reguły adresu IP. ciąg
maska ip Blok CIDR definiujący zakres adresów IP. ciąg

Zestawy reguł sieciowychNetworkRuleSets

Nazwa Opis Wartość
applyToDevices (zastosuj się) Czy te reguły mają zastosowanie do łączności urządzeń z usługą IoT Hub i Device Provisioning skojarzona z tą aplikacją. Bool
applyToIoTCentral Czy te reguły mają zastosowanie do łączności za pośrednictwem portalu internetowego i interfejsów API usługi IoT Central. Bool
defaultAction (akcja domyślna) Domyślna akcja sieciowa do zastosowania. "Zezwalaj"
"Odmów"
Reguły ip Lista reguł adresów IP. Reguła SieciowaUstawionaIpReguła[]

SystemAssignedServiceIdentity (tożsamość usługi)

Nazwa Opis Wartość
typ Typ tożsamości usługi zarządzanej (przypisany system lub brak). "Brak"
"SystemAssigned" (wymagane)

Śledzone tagi zasobów

Nazwa Opis Wartość

Przykłady użycia

Przykłady programu Terraform

Podstawowy przykład wdrażania aplikacji 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    = ["*"]
}