Ambientes Microsoft.TimeSeriesInsights 2021-03-31-preview

  • Artigo

Definição de recurso do Bicep

O tipo de recurso de ambientes pode ser implantado com operações direcionadas:

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

Formato de recurso

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

Defina a propriedade kind para especificar o tipo de objeto.

Para Gen1, use:

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

Para Gen2, use:

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

Valores de propriedade

environments

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

Limite de caracteres: 1 a 90

Caracteres válidos:
Não é possível usar:
'<>%&:\?/# ou caracteres de controle
local A localização do recurso. cadeia de caracteres (obrigatório)
marcas Pares chave-valor de propriedades adicionais para o recurso. Dicionário de nomes e valores de marcas. Consulte Marcas 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 cobrança. SKU (obrigatório)
kind Definir o tipo de objeto Gen1
Gen2 (obrigatório)

Gen1EnvironmentCreateOrUpdateParametersOrGen1Environ...

Nome Descrição Valor
kind O tipo do ambiente. 'Gen1' (obrigatório)
properties Propriedades usadas para criar um ambiente Gen1. Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe... (obrigatório)

Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe...

Nome Descrição Valor
dataRetentionTime Período de tempo ISO8601 especificando o número mínimo de dias em que os eventos do ambiente estarão disponíveis para consulta. cadeia de caracteres (obrigatório)
partitionKeyProperties A lista de propriedades de evento que serão usadas para particionar dados no ambiente. Atualmente, há suporte para apenas 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, novos eventos não serão lidos da origem do evento. Se "PurgeOldData" for especificado, novos eventos continuarão a ser lidos e eventos antigos serão excluídos do ambiente. O comportamento padrão é PurgeOldData. 'PauseIngress'
'PurgeOldData'

TimeSeriesIdProperty

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

Gen2EnvironmentCreateOrUpdateParametersOrGen2Environ...

Nome Descrição Valor
kind O tipo do ambiente. 'Gen2' (obrigatório)
properties Propriedades usadas para criar um ambiente Gen2. Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe... (obrigatório)

Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe...

Nome Descrição Valor
publicNetworkAccess Esse valor pode ser definido como "habilitado" para evitar alterações interruptivas em modelos e recursos existentes do cliente. Se definido como "desabilitado", o tráfego pela interface pública não será permitido e as conexões de ponto de extremidade privado serão o método de acesso exclusivo. 'desabilitado'
'enabled'
storageConfiguration A configuração de armazenamento fornece os detalhes de conexão que permitem que o serviço Time Series Insights se conecte à conta de armazenamento do cliente usada para armazenar os dados do ambiente. Gen2StorageConfigurationInputOrGen2StorageConfigurat... (obrigatório)
timeSeriesIdProperties A lista de propriedades de evento que serão usadas para definir a ID da série temporal do ambiente. TimeSeriesIdProperty[] (obrigatório)
warmStoreConfiguration A configuração de repositório warm fornece os detalhes para criar um cache de repositório warm que 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 conterá os dados gen2 do ambiente. cadeia de caracteres (obrigatório)
Managementkey O valor da chave de gerenciamento que concede ao serviço Time Series Insights acesso de gravação à conta de armazenamento. Essa propriedade não é mostrada em respostas de ambiente. cadeia de caracteres (obrigatório)

WarmStoreConfigurationProperties

Nome Descrição Valor
dataRetention Intervalo de tempo ISO8601 especificando o número de dias em que os eventos do ambiente estarão disponíveis para consulta no repositório warm. cadeia de caracteres (obrigatório)

Sku

Nome Descrição Valor
ALOCADA A capacidade do sku. Para ambientes Gen1, esse valor pode ser alterado para dar suporte à expansão de ambientes depois que eles tiverem sido criados. int (obrigatório)
name O nome dessa SKU. 'L1'
'P1'
'S1'
'S2' (obrigatório)

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
Criar um ambiente PAYG (Pagamento Conforme o Uso) com um Hub IoT

Implantar no Azure		 Este modelo permite que você implante um ambiente pay as you go (PAYG) Time Series Insights configurado para consumir eventos de um Hub IoT.
Criar um ambiente com uma origem de evento do Hub de Eventos

Implantar no Azure		 Esse modelo permite que você implante um ambiente do Time Series Insights configurado para consumir eventos de um Hub de Eventos.

Definição de recurso de modelo do ARM

O tipo de recurso de ambientes pode ser implantado com operações direcionadas:

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

Formato de recurso

Para criar um recurso Microsoft.TimeSeriesInsights/environments, adicione o JSON a seguir ao 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 environments

Defina a propriedade de tipo para especificar o tipo de objeto.

Para Gen1, use:

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

Para Gen2, use:

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

Valores de propriedade

environments

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

Limite de caracteres: 1 a 90

Caracteres válidos:
Não é possível usar:
'<>%&:\?/# ou caracteres de controle
local A localização do recurso. cadeia de caracteres (obrigatório)
marcas Pares chave-valor de propriedades adicionais para o recurso. Dicionário de nomes e valores de marcas. Confira Marcas 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 cobrança. SKU (obrigatório)
kind Definir o tipo de objeto Gen1
Gen2 (obrigatório)

Gen1EnvironmentCreateOrUpdateParametersOrGen1Environ...

Nome Descrição Valor
kind O tipo do ambiente. 'Gen1' (obrigatório)
properties Propriedades usadas para criar um ambiente Gen1. Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe... (obrigatório)

Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe...

Nome Descrição Valor
dataRetentionTime Período de tempo ISO8601 especificando o número mínimo de dias em que os eventos do ambiente estarão disponíveis para consulta. cadeia de caracteres (obrigatório)
partitionKeyProperties A lista de propriedades de evento que serão usadas para particionar dados no ambiente. Atualmente, há suporte para apenas 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, novos eventos não serão lidos da origem do evento. Se "PurgeOldData" for especificado, novos eventos continuarão a ser lidos e eventos antigos serão excluídos do ambiente. O comportamento padrão é PurgeOldData. 'PauseIngress'
'PurgeOldData'

TimeSeriesIdProperty

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

Gen2EnvironmentCreateOrUpdateParametersOrGen2Environ...

Nome Descrição Valor
kind O tipo do ambiente. 'Gen2' (obrigatório)
properties Propriedades usadas para criar um ambiente Gen2. Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe... (obrigatório)

Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe...

Nome Descrição Valor
publicNetworkAccess Esse valor pode ser definido como "habilitado" para evitar alterações interruptivas nos recursos e modelos existentes do cliente. Se definido como "desabilitado", o tráfego pela interface pública não será permitido e as conexões de ponto de extremidade privado serão o método de acesso exclusivo. 'desabilitado'
'enabled'
storageConfiguration A configuração de armazenamento fornece os detalhes de conexão que permitem que o serviço Time Series Insights se conecte à conta de armazenamento do cliente usada para armazenar os dados do ambiente. Gen2StorageConfigurationInputOrGen2StorageConfigurat... (obrigatório)
timeSeriesIdProperties A lista de propriedades de evento que serão usadas para definir a ID da série temporal do ambiente. TimeSeriesIdProperty[] (obrigatório)
warmStoreConfiguration A configuração do repositório warm fornece os detalhes para criar um cache de repositório quente que 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 armazenará os dados gen2 do ambiente. cadeia de caracteres (obrigatório)
Managementkey O valor da chave de gerenciamento que concede ao serviço Time Series Insights acesso de gravação à conta de armazenamento. Essa propriedade não é mostrada em respostas de ambiente. cadeia de caracteres (obrigatório)

WarmStoreConfigurationProperties

Nome Descrição Valor
dataRetention Intervalo de tempo ISO8601 especificando o número de dias em que os eventos do ambiente estarão disponíveis para consulta no repositório warm. cadeia de caracteres (obrigatório)

Sku

Nome Descrição Valor
ALOCADA A capacidade do sku. Para ambientes Gen1, esse valor pode ser alterado para dar suporte à expansão de ambientes depois de terem sido criados. int (obrigatório)
name O nome desse SKU. 'L1'
'P1'
'S1'
'S2' (obrigatório)

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
Criar um ambiente PAYG (Pagamento Conforme o Uso) com um Hub IoT

Implantar no Azure		 Este modelo permite que você implante um ambiente pay as you go (PAYG) Time Series Insights configurado para consumir eventos de um Hub IoT.
Criar um ambiente com uma origem de evento do Hub de Eventos

Implantar no Azure		 Esse modelo permite que você implante um ambiente do Time Series Insights configurado para consumir eventos de um Hub de Eventos.

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

O tipo de recurso de ambientes pode ser implantado com operações direcionadas:

  • Grupos de recursos

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

Formato de recurso

Para criar um recurso Microsoft.TimeSeriesInsights/environments, adicione o Terraform a seguir ao 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 environments

Defina a propriedade de tipo para especificar o tipo de objeto.

Para Gen1, use:

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

Para Gen2, use:

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

Valores de propriedade

environments

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

Limite de caracteres: 1 a 90

Caracteres válidos:
Não é possível usar:
'<>%&:\?/# ou caracteres de controle
local A localização do recurso. cadeia de caracteres (obrigatório)
parent_id Para implantar em um grupo de recursos, use a ID desse grupo de recursos. cadeia de caracteres (obrigatório)
marcas Pares chave-valor de propriedades adicionais para o recurso. Dicionário de nomes e valores de marcas.
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 cobrança. SKU (obrigatório)
kind Definir o tipo de objeto Gen1
Gen2 (obrigatório)

Gen1EnvironmentCreateOrUpdateParametersOrGen1Environ...

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

Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe...

Nome Descrição Valor
dataRetentionTime Intervalo de tempo ISO8601 especificando o número mínimo de dias em que os eventos do ambiente estarão disponíveis para consulta. cadeia de caracteres (obrigatório)
partitionKeyProperties A lista de propriedades de evento que serão usadas para particionar dados no ambiente. Atualmente, há suporte apenas para 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, novos eventos não serão lidos da origem do evento. Se "PurgeOldData" for especificado, novos eventos continuarão a ser lidos e eventos antigos serão excluídos do ambiente. O comportamento padrão é PurgeOldData. "PauseIngress"
"PurgeOldData"

TimeSeriesIdProperty

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

Gen2EnvironmentCreateOrUpdateParametersOrGen2Environ...

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

Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe...

Nome Descrição Valor
publicNetworkAccess Esse valor pode ser definido como "habilitado" para evitar alterações interruptivas nos recursos e modelos existentes do cliente. Se definido como "desabilitado", o tráfego pela interface pública não será permitido e as conexões de ponto de extremidade privado serão o método de acesso exclusivo. "desabilitado”
"habilitado"
storageConfiguration A configuração de armazenamento fornece os detalhes de conexão que permitem que o serviço Time Series Insights se conecte à conta de armazenamento do cliente usada para armazenar os dados do ambiente. Gen2StorageConfigurationInputOrGen2StorageConfigurat... (obrigatório)
timeSeriesIdProperties A lista de propriedades de evento que serão usadas para definir a ID da série temporal do ambiente. TimeSeriesIdProperty[] (obrigatório)
warmStoreConfiguration A configuração do repositório warm fornece os detalhes para criar um cache de repositório quente que 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 armazenará os dados gen2 do ambiente. cadeia de caracteres (obrigatório)
Managementkey O valor da chave de gerenciamento que concede ao serviço Time Series Insights acesso de gravação à conta de armazenamento. Essa propriedade não é mostrada em respostas de ambiente. cadeia de caracteres (obrigatório)

WarmStoreConfigurationProperties

Nome Descrição Valor
dataRetention Intervalo de tempo ISO8601 especificando o número de dias em que os eventos do ambiente estarão disponíveis para consulta no repositório warm. cadeia de caracteres (obrigatório)

Sku

Nome Descrição Valor
ALOCADA A capacidade do sku. Para ambientes Gen1, esse valor pode ser alterado para dar suporte à expansão de ambientes depois de terem sido criados. int (obrigatório)
name O nome desse SKU. "L1"
"P1"
"S1"
"S2" (obrigatório)