Partilhar via


Ambientes Microsoft.TimeSeriesInsights 2021-03-31-preview

Definição de recurso do Bicep

O tipo de recurso ambientes pode ser implementado com operações que visam:

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

Formato do recurso

Para criar um recurso Microsoft.TimeSeriesInsights/environments, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.TimeSeriesInsights/environments@2021-03-31-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  kind: 'string'
  // For remaining properties, see environments objects
}

objetos de ambientes

Defina a propriedade kind para especificar o tipo de objeto.

Para Gen1, utilize:

  kind: 'Gen1'
  properties: {
    dataRetentionTime: 'string'
    partitionKeyProperties: [
      {
        name: 'string'
        type: 'String'
      }
    ]
    storageLimitExceededBehavior: 'string'
  }

Para Gen2, utilize:

  kind: 'Gen2'
  properties: {
    publicNetworkAccess: 'string'
    storageConfiguration: {
      accountName: 'string'
      managementKey: 'string'
    }
    timeSeriesIdProperties: [
      {
        name: 'string'
        type: 'String'
      }
    ]
    warmStoreConfiguration: {
      dataRetention: 'string'
    }
  }

Valores de propriedade

ambientes

Nome Descrição Valor
name O nome do recurso cadeia (obrigatório)

Limite de carateres: 1-90

Carateres válidos:
Não é possível utilizar:
'<>%&:\?/# ou controlar carateres
localização A localização do recurso. cadeia (obrigatório)
etiquetas Pares chave-valor de propriedades adicionais para o recurso. Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
sku O sku determina o tipo de ambiente, Gen1 (S1 ou S2) ou Gen2 (L1). Para ambientes Gen1, o sku determina a capacidade do ambiente, a taxa de entrada e a taxa de faturação. SKU (obrigatório)
tipo Definir o tipo de objeto Gen1
Gen2 (obrigatório)

Gen1EnvironmentCreateOrUpdateParametersOrGen1Environ...

Nome Descrição Valor
tipo O tipo de ambiente. "Gen1" (obrigatório)
propriedades Propriedades utilizadas para criar um ambiente Gen1. Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe... (obrigatório)

Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe...

Nome Descrição Valor
dataRetentionTime ISO8601 timespan especificando o número mínimo de dias em que os eventos do ambiente estarão disponíveis para consulta. cadeia (obrigatório)
partitionKeyProperties A lista de propriedades do evento que serão utilizadas para criar partições de dados no ambiente. Atualmente, apenas é suportada uma única propriedade de chave de partição. TimeSeriesIdProperty[]
storageLimitExceededBehavior O comportamento que o serviço Time Series Insights deve ter quando a capacidade do ambiente foi excedida. Se "PauseIngress" for especificado, os novos eventos não serão lidos a partir da origem do evento. Se "PurgeOldData" for especificado, os novos eventos continuarão a ser lidos e os eventos antigos serão eliminados do ambiente. O comportamento predefinido é PurgeOldData. 'PauseIngress'
'PurgeOldData'

TimeSeriesIdProperty

Nome Descrição Valor
name O nome da propriedade. string
tipo O tipo da propriedade. 'Cadeia'

Gen2EnvironmentCreateOrUpdateParametersOrGen2Environ...

Nome Descrição Valor
tipo O tipo de ambiente. "Gen2" (obrigatório)
propriedades Propriedades utilizadas para criar um ambiente Gen2. Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe... (obrigatório)

Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe...

Nome Descrição Valor
publicNetworkAccess Este valor pode ser definido como "ativado" para evitar alterações interruptivas nos modelos e recursos de cliente existentes. Se estiver definido como "desativado", o tráfego através da interface pública não é permitido e as ligações de ponto final privado seriam o método de acesso exclusivo. "desativado"
"ativado"
storageConfiguration A configuração de armazenamento fornece os detalhes de ligação que permitem que o serviço Time Series Insights se ligue à conta de armazenamento do cliente que é utilizada para armazenar os dados do ambiente. Gen2StorageConfigurationInputOrGen2StorageConfigurat... (obrigatório)
timeSeriesIdProperties A lista de propriedades do evento que serão utilizadas para definir o ID da série temporal do ambiente. TimeSeriesIdProperty[] (obrigatório)
warmStoreConfiguration A configuração de arquivo quente fornece os detalhes para criar uma cache de arquivo quente que irá manter uma cópia dos dados do ambiente disponíveis para uma consulta mais rápida. WarmStoreConfigurationProperties

Gen2StorageConfigurationInputOrGen2StorageConfigurat...

Nome Descrição Valor
accountName O nome da conta de armazenamento que irá conter os dados gen2 do ambiente. cadeia (obrigatório)
managementKey O valor da chave de gestão que concede ao serviço Time Series Insights acesso de escrita à conta de armazenamento. Esta propriedade não é apresentada nas respostas do ambiente. cadeia (obrigatório)

WarmStoreConfigurationProperties

Nome Descrição Valor
dataRetention ISO8601 timespan especificando o número de dias em que os eventos do ambiente estarão disponíveis para consulta a partir do arquivo quente. cadeia (obrigatório)

Sku

Nome Descrição Valor
capacidade A capacidade do SKU. Para ambientes Gen1, este valor pode ser alterado para suportar o aumento horizontal dos ambientes depois de terem sido criados. int (obrigatório)
name O nome deste SKU. 'L1'
'P1'
'S1'
'S2' (obrigatório)

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo Description
Criar um Ambiente Pay As You Go (PAYG) com um Hub IoT

Implementar no Azure
Este modelo permite-lhe implementar um ambiente pay as you go (PAYG) do Time Series Insights configurado para consumir eventos de um Hub IoT.
Criar um Ambiente com uma Origem de Eventos do Hub de Eventos

Implementar no Azure
Este modelo permite-lhe implementar um ambiente do Time Series Insights configurado para consumir eventos a partir de um Hub de Eventos.

Definição de recurso do modelo arm

O tipo de recurso ambientes pode ser implementado com operações que visam:

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

Formato do recurso

Para criar um recurso Microsoft.TimeSeriesInsights/environments, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.TimeSeriesInsights/environments",
  "apiVersion": "2021-03-31-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "kind": "string",
  // For remaining properties, see environments objects
}

objetos de ambientes

Defina a propriedade kind para especificar o tipo de objeto.

Para Gen1, utilize:

  "kind": "Gen1",
  "properties": {
    "dataRetentionTime": "string",
    "partitionKeyProperties": [
      {
        "name": "string",
        "type": "String"
      }
    ],
    "storageLimitExceededBehavior": "string"
  }

Para Gen2, utilize:

  "kind": "Gen2",
  "properties": {
    "publicNetworkAccess": "string",
    "storageConfiguration": {
      "accountName": "string",
      "managementKey": "string"
    },
    "timeSeriesIdProperties": [
      {
        "name": "string",
        "type": "String"
      }
    ],
    "warmStoreConfiguration": {
      "dataRetention": "string"
    }
  }

Valores de propriedade

ambientes

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.TimeSeriesInsights/environments"
apiVersion A versão da API de recursos '2021-03-31-preview'
name O nome do recurso cadeia (obrigatório)

Limite de carateres: 1-90

Carateres válidos:
Não é possível utilizar:
'<>%&:\?/# ou controlar carateres
localização A localização do recurso. cadeia (obrigatório)
etiquetas Pares chave-valor de propriedades adicionais para o recurso. Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
sku O sku determina o tipo de ambiente, Gen1 (S1 ou S2) ou Gen2 (L1). Para ambientes Gen1, o sku determina a capacidade do ambiente, a taxa de entrada e a taxa de faturação. SKU (obrigatório)
tipo Definir o tipo de objeto Gen1
Gen2 (obrigatório)

Gen1EnvironmentCreateOrUpdateParametersOrGen1Environ...

Nome Descrição Valor
tipo O tipo de ambiente. "Gen1" (obrigatório)
propriedades Propriedades utilizadas para criar um ambiente Gen1. Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe... (obrigatório)

Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe...

Nome Descrição Valor
dataRetentionTime ISO8601 timespan especificando o número mínimo de dias em que os eventos do ambiente estarão disponíveis para consulta. cadeia (obrigatório)
partitionKeyProperties A lista de propriedades do evento que serão utilizadas para criar partições de dados no ambiente. Atualmente, apenas é suportada uma única propriedade de chave de partição. TimeSeriesIdProperty[]
storageLimitExceededBehavior O comportamento que o serviço Time Series Insights deve ter quando a capacidade do ambiente foi excedida. Se "PauseIngress" for especificado, os novos eventos não serão lidos a partir da origem do evento. Se "PurgeOldData" for especificado, os novos eventos continuarão a ser lidos e os eventos antigos serão eliminados do ambiente. O comportamento predefinido é PurgeOldData. 'PauseIngress'
'PurgeOldData'

TimeSeriesIdProperty

Nome Descrição Valor
name O nome da propriedade. string
tipo O tipo da propriedade. 'Cadeia'

Gen2EnvironmentCreateOrUpdateParametersOrGen2Environ...

Nome Descrição Valor
tipo O tipo de ambiente. "Gen2" (obrigatório)
propriedades Propriedades utilizadas para criar um ambiente Gen2. Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe... (obrigatório)

Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe...

Nome Descrição Valor
publicNetworkAccess Este valor pode ser definido como "ativado" para evitar alterações interruptivas nos recursos e modelos de clientes existentes. Se estiver definido como "desativado", o tráfego através da interface pública não é permitido e as ligações de ponto final privado seriam o método de acesso exclusivo. "desativado"
"ativado"
storageConfiguration A configuração de armazenamento fornece os detalhes de ligação que permitem que o serviço Time Series Insights se ligue à conta de armazenamento do cliente que é utilizada para armazenar os dados do ambiente. Gen2StorageConfigurationInputOrGen2StorageConfigurat... (obrigatório)
timeSeriesIdProperties A lista de propriedades do evento que serão utilizadas para definir o ID da série temporal do ambiente. TimeSeriesIdProperty[] (obrigatório)
warmStoreConfiguration A configuração do arquivo quente fornece os detalhes para criar uma cache de arquivo quente que irá reter uma cópia dos dados do ambiente disponíveis para uma consulta mais rápida. WarmStoreConfigurationProperties

Gen2StorageConfigurationInputOrGen2StorageConfigurat...

Nome Descrição Valor
accountName O nome da conta de armazenamento que irá conter os dados gen2 do ambiente. cadeia (obrigatório)
managementKey O valor da chave de gestão que concede ao serviço Time Series Insights acesso de escrita à conta de armazenamento. Esta propriedade não é apresentada nas respostas do ambiente. cadeia (obrigatório)

WarmStoreConfigurationProperties

Nome Descrição Valor
dataRetention ISO8601 timespan especificando o número de dias em que os eventos do ambiente estarão disponíveis para consulta a partir do arquivo quente. cadeia (obrigatório)

Sku

Nome Descrição Valor
capacidade A capacidade do sku. Para ambientes Gen1, este valor pode ser alterado para suportar o aumento horizontal dos ambientes após terem sido criados. int (obrigatório)
name O nome deste SKU. "L1"
'P1'
'S1'
"S2" (obrigatório)

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo Description
Criar um Ambiente Pay As You Go (PAYG) com um Hub IoT

Implementar no Azure
Este modelo permite-lhe implementar um ambiente pay as you go (PAYG) do Time Series Insights configurado para consumir eventos de um Hub IoT.
Criar um Ambiente com uma Origem de Eventos do Hub de Eventos

Implementar no Azure
Este modelo permite-lhe implementar um ambiente do Time Series Insights configurado para consumir eventos a partir de um Hub de Eventos.

Definição de recurso terraform (fornecedor AzAPI)

O tipo de recurso ambientes pode ser implementado com operações que visam:

  • Grupos de recursos

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

Formato do recurso

Para criar um recurso Microsoft.TimeSeriesInsights/environments, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.TimeSeriesInsights/environments@2021-03-31-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  // For remaining properties, see environments objects
  body = jsonencode({
    sku = {
      capacity = int
      name = "string"
    }
    kind = "string"
  })
}

objetos de ambientes

Defina a propriedade kind para especificar o tipo de objeto.

Para Gen1, utilize:

  kind = "Gen1"
  properties = {
    dataRetentionTime = "string"
    partitionKeyProperties = [
      {
        name = "string"
        type = "String"
      }
    ]
    storageLimitExceededBehavior = "string"
  }

Para Gen2, utilize:

  kind = "Gen2"
  properties = {
    publicNetworkAccess = "string"
    storageConfiguration = {
      accountName = "string"
      managementKey = "string"
    }
    timeSeriesIdProperties = [
      {
        name = "string"
        type = "String"
      }
    ]
    warmStoreConfiguration = {
      dataRetention = "string"
    }
  }

Valores de propriedade

ambientes

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.TimeSeriesInsights/environments@2021-03-31-preview"
name O nome do recurso cadeia (obrigatório)

Limite de carateres: 1-90

Carateres válidos:
Não é possível utilizar:
'<>%&:\?/# ou controlar carateres
localização A localização do recurso. cadeia (obrigatório)
parent_id Para implementar num grupo de recursos, utilize o ID desse grupo de recursos. cadeia (obrigatório)
etiquetas Pares chave-valor de propriedades adicionais para o recurso. Dicionário de nomes e valores de etiquetas.
sku O sku determina o tipo de ambiente, Gen1 (S1 ou S2) ou Gen2 (L1). Para ambientes Gen1, o sku determina a capacidade do ambiente, a taxa de entrada e a taxa de faturação. SKU (obrigatório)
tipo Definir o tipo de objeto Gen1
Gen2 (obrigatório)

Gen1EnvironmentCreateOrUpdateParametersOrGen1Environ...

Nome Descrição Valor
tipo O tipo de ambiente. "Gen1" (obrigatório)
propriedades Propriedades utilizadas para criar um ambiente Gen1. Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe... (obrigatório)

Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe...

Nome Descrição Valor
dataRetentionTime ISO8601 timespan especificando o número mínimo de dias em que os eventos do ambiente estarão disponíveis para consulta. cadeia (obrigatório)
partitionKeyProperties A lista de propriedades de eventos que serão utilizadas para particionar dados no ambiente. Atualmente, só é suportada uma única propriedade de chave de partição. TimeSeriesIdProperty[]
storageLimitExceededBehavior O comportamento que o serviço Time Series Insights deve ter quando a capacidade do ambiente foi excedida. Se "PauseIngress" for especificado, os novos eventos não serão lidos a partir da origem do evento. Se "PurgeOldData" for especificado, os novos eventos continuarão a ser lidos e os eventos antigos serão eliminados do ambiente. O comportamento predefinido é PurgeOldData. "PauseIngress"
"PurgeOldData"

TimeSeriesIdProperty

Nome Descrição Valor
name O nome da propriedade . string
tipo O tipo da propriedade . "Cadeia"

Gen2EnvironmentCreateOrUpdateParametersOrGen2Environ...

Nome Descrição Valor
tipo O tipo de ambiente. "Gen2" (obrigatório)
propriedades Propriedades utilizadas para criar um ambiente Gen2. Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe... (obrigatório)

Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe...

Nome Descrição Valor
publicNetworkAccess Este valor pode ser definido como "ativado" para evitar alterações interruptivas nos modelos e recursos de cliente existentes. Se estiver definido como "desativado", o tráfego através da interface pública não é permitido e as ligações de ponto final privado seriam o método de acesso exclusivo. "desativado"
"ativado"
storageConfiguration A configuração de armazenamento fornece os detalhes de ligação que permitem que o serviço Time Series Insights se ligue à conta de armazenamento do cliente que é utilizada para armazenar os dados do ambiente. Gen2StorageConfigurationInputOrGen2StorageConfigurat... (obrigatório)
timeSeriesIdProperties A lista de propriedades do evento que serão utilizadas para definir o ID da série temporal do ambiente. TimeSeriesIdProperty[] (obrigatório)
warmStoreConfiguration A configuração de arquivo quente fornece os detalhes para criar uma cache de arquivo quente que irá manter uma cópia dos dados do ambiente disponíveis para uma consulta mais rápida. WarmStoreConfigurationProperties

Gen2StorageConfigurationInputOrGen2StorageConfigurat...

Nome Descrição Valor
accountName O nome da conta de armazenamento que irá conter os dados gen2 do ambiente. cadeia (obrigatório)
managementKey O valor da chave de gestão que concede ao serviço Time Series Insights acesso de escrita à conta de armazenamento. Esta propriedade não é apresentada nas respostas do ambiente. cadeia (obrigatório)

WarmStoreConfigurationProperties

Nome Descrição Valor
dataRetention ISO8601 timespan especificando o número de dias em que os eventos do ambiente estarão disponíveis para consulta a partir do arquivo quente. cadeia (obrigatório)

Sku

Nome Descrição Valor
capacidade A capacidade do SKU. Para ambientes Gen1, este valor pode ser alterado para suportar o aumento horizontal dos ambientes depois de terem sido criados. int (obrigatório)
name O nome deste SKU. "L1"
"P1"
"S1"
"S2" (obrigatório)