Partager via

Environnements Microsoft.TimeSeriesInsights

  • Article

Définition de ressource Bicep

Le type de ressource environnements peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.TimeSeriesInsights/environments, ajoutez le Bicep suivant à votre modèle.

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

objets environments

Définissez la propriété kind pour spécifier le type d’objet.

Pour Gen1, utilisez :

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

Pour Gen2, utilisez :

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

Valeurs de propriétés

environments

Nom Description Valeur
name Nom de la ressource string (obligatoire)

Limite de caractères : 1-90

Caractères valides :
Impossibilité d’utiliser :
'<>%&:\?/# ou des caractères de contrôle.
location Emplacement de la ressource. string (obligatoire)
tags Paires clé-valeur de propriétés supplémentaires pour la ressource. Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
sku La référence sKU détermine le type d’environnement, Gen1 (S1 ou S2) ou Gen2 (L1). Pour les environnements Gen1, la référence sku détermine la capacité de l’environnement, le taux d’entrée et le taux de facturation. Référence SKU (obligatoire)
kind Définir le type d’objet Première génération
Gen2 (obligatoire)

Gen1EnvironmentCreateOrUpdateParametersOrGen1Environ...

Nom Description Valeur
kind Le type de l’environnement. 'Gen1' (obligatoire)
properties Propriétés utilisées pour créer un environnement Gen1. Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe... (obligatoire)

Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe...

Nom Description Valeur
dataRetentionTime Intervalle de temps ISO8601 spécifiant le nombre minimal de jours pendant lesquels les événements de l’environnement seront disponibles pour la requête. string (obligatoire)
partitionKeyProperties Liste des propriétés d’événement qui seront utilisées pour partitionner les données dans l’environnement. Actuellement, une seule propriété de clé de partition est prise en charge. TimeSeriesIdProperty[]
storageLimitExceededBehavior Comportement que le service Time Series Insights doit adopter lorsque la capacité de l’environnement a été dépassée. Si « PauseIngress » est spécifié, les nouveaux événements ne sont pas lus à partir de la source de l’événement. Si « PurgeOldData » est spécifié, les nouveaux événements continueront d’être lus et les anciens événements seront supprimés de l’environnement. Le comportement par défaut est PurgeOldData. 'PauseIngress'
'PurgeOldData'

TimeSeriesIdProperty

Nom Description Valeur
name Nom de la propriété. string
type Type de la propriété. 'String'

Gen2EnvironmentCreateOrUpdateParametersOrGen2Environ...

Nom Description Valeur
kind Le type de l’environnement. 'Gen2' (obligatoire)
properties Propriétés utilisées pour créer un environnement Gen2. Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe... (obligatoire)

Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe...

Nom Description Valeur
storageConfiguration La configuration du stockage fournit les détails de connexion qui permettent au service Time Series Insights de se connecter au compte de stockage client utilisé pour stocker les données de l’environnement. Gen2StorageConfigurationInputOrGen2StorageConfigurat... (obligatoire)
timeSeriesIdProperties Liste des propriétés d’événement qui seront utilisées pour définir l’ID de série chronologique de l’environnement. TimeSeriesIdProperty[] (obligatoire)
warmStoreConfiguration La configuration du magasin chaud fournit les détails permettant de créer un cache de magasin chaud qui conservera une copie des données de l’environnement disponibles pour une requête plus rapide. WarmStoreConfigurationProperties

Gen2StorageConfigurationInputOrGen2StorageConfigurat...

Nom Description Valeur
accountName Nom du compte de stockage qui contiendra les données Gen2 de l’environnement. string (obligatoire)
managementKey Valeur de la clé de gestion qui accorde au service Time Series Insights un accès en écriture au compte de stockage. Cette propriété n’est pas affichée dans les réponses d’environnement. string (obligatoire)

WarmStoreConfigurationProperties

Nom Description Valeur
dataRetention Intervalle de temps ISO8601 spécifiant le nombre de jours pendant lesquels les événements de l’environnement seront disponibles pour une requête à partir du magasin chaud. string (obligatoire)

Sku

Nom Description Valeur
capacité Capacité de la référence SKU. Pour les environnements Gen1, cette valeur peut être modifiée pour prendre en charge le scale-out des environnements après leur création. int (obligatoire)
name Nom de cette référence SKU. 'L1'
'P1'
'S1'
'S2' (obligatoire)

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle Description
Créer un environnement de paiement à l’utilisation (PAYG) avec un IoT Hub

Déployer sur Azure		 Ce modèle vous permet de déployer un environnement Pay As You Go (PAYG) Time Series Insights configuré pour consommer des événements à partir d’un IoT Hub.
Créer un environnement avec une source d’événements Event Hub

Déployer sur Azure		 Ce modèle vous permet de déployer un environnement Time Series Insights configuré pour consommer des événements à partir d’un hub d’événements.

Définition de ressources de modèle ARM

Le type de ressource environnements peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.TimeSeriesInsights/environments, ajoutez le code JSON suivant à votre modèle.

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

objets environments

Définissez la propriété kind pour spécifier le type d’objet.

Pour Gen1, utilisez :

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

Pour Gen2, utilisez :

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

Valeurs de propriétés

environments

Nom Description Valeur
type Type de ressource « Microsoft.TimeSeriesInsights/environments »
apiVersion Version de l’API de ressource '2021-06-30-preview'
name Nom de la ressource string (obligatoire)

Limite de caractères : 1-90

Caractères valides :
Impossibilité d’utiliser :
'<>%&:\?/# ou des caractères de contrôle.
location Emplacement de la ressource. string (obligatoire)
tags Paires clé-valeur de propriétés supplémentaires pour la ressource. Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles
sku La référence sKU détermine le type d’environnement, Gen1 (S1 ou S2) ou Gen2 (L1). Pour les environnements Gen1, la référence sku détermine la capacité de l’environnement, le taux d’entrée et le taux de facturation. Référence SKU (obligatoire)
kind Définir le type d’objet Première génération
Gen2 (obligatoire)

Gen1EnvironmentCreateOrUpdateParametersOrGen1Environ...

Nom Description Valeur
kind Le type de l’environnement. 'Gen1' (obligatoire)
properties Propriétés utilisées pour créer un environnement Gen1. Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe... (obligatoire)

Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe...

Nom Description Valeur
dataRetentionTime Intervalle de temps ISO8601 spécifiant le nombre minimal de jours pendant lesquels les événements de l’environnement seront disponibles pour la requête. string (obligatoire)
partitionKeyProperties Liste des propriétés d’événement qui seront utilisées pour partitionner les données dans l’environnement. Actuellement, une seule propriété de clé de partition est prise en charge. TimeSeriesIdProperty[]
storageLimitExceededBehavior Comportement que le service Time Series Insights doit adopter lorsque la capacité de l’environnement a été dépassée. Si « PauseIngress » est spécifié, les nouveaux événements ne sont pas lus à partir de la source de l’événement. Si « PurgeOldData » est spécifié, les nouveaux événements continueront d’être lus et les anciens événements seront supprimés de l’environnement. Le comportement par défaut est PurgeOldData. 'PauseIngress'
'PurgeOldData'

TimeSeriesIdProperty

Nom Description Valeur
name Nom de la propriété. string
type Type de la propriété. 'String'

Gen2EnvironmentCreateOrUpdateParametersOrGen2Environ...

Nom Description Valeur
kind Le type de l’environnement. 'Gen2' (obligatoire)
properties Propriétés utilisées pour créer un environnement Gen2. Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe... (obligatoire)

Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe...

Nom Description Valeur
storageConfiguration La configuration du stockage fournit les détails de connexion qui permettent au service Time Series Insights de se connecter au compte de stockage client utilisé pour stocker les données de l’environnement. Gen2StorageConfigurationInputOrGen2StorageConfigurat... (obligatoire)
timeSeriesIdProperties Liste des propriétés d’événement qui seront utilisées pour définir l’ID de série chronologique de l’environnement. TimeSeriesIdProperty[] (obligatoire)
warmStoreConfiguration La configuration du magasin chaud fournit les détails permettant de créer un cache de magasin chaud qui conservera une copie des données de l’environnement disponibles pour une requête plus rapide. WarmStoreConfigurationProperties

Gen2StorageConfigurationInputOrGen2StorageConfigurat...

Nom Description Valeur
accountName Nom du compte de stockage qui contiendra les données Gen2 de l’environnement. string (obligatoire)
managementKey Valeur de la clé de gestion qui accorde au service Time Series Insights un accès en écriture au compte de stockage. Cette propriété n’est pas affichée dans les réponses d’environnement. string (obligatoire)

WarmStoreConfigurationProperties

Nom Description Valeur
dataRetention Intervalle de temps ISO8601 spécifiant le nombre de jours pendant lesquels les événements de l’environnement seront disponibles pour une requête à partir du magasin chaud. string (obligatoire)

Sku

Nom Description Valeur
capacité Capacité de la référence SKU. Pour les environnements Gen1, cette valeur peut être modifiée pour prendre en charge le scale-out des environnements après leur création. int (obligatoire)
name Nom de cette référence SKU. 'L1'
'P1'
'S1'
'S2' (obligatoire)

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle Description
Créer un environnement de paiement à l’utilisation (PAYG) avec un IoT Hub

Déployer sur Azure		 Ce modèle vous permet de déployer un environnement Pay As You Go (PAYG) Time Series Insights configuré pour consommer des événements à partir d’un IoT Hub.
Créer un environnement avec une source d’événements Event Hub

Déployer sur Azure		 Ce modèle vous permet de déployer un environnement Time Series Insights configuré pour consommer des événements à partir d’un hub d’événements.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource environnements peut être déployé avec des opérations qui ciblent :

  • Groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.TimeSeriesInsights/environments, ajoutez le Terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.TimeSeriesInsights/environments@2021-06-30-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"
  })
}

objets d’environnements

Définissez la propriété kind pour spécifier le type d’objet.

Pour Gen1, utilisez :

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

Pour Gen2, utilisez :

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

Valeurs de propriétés

environments

Nom Description Valeur
type Type de ressource « Microsoft.TimeSeriesInsights/environments@2021-06-30-preview »
name Nom de la ressource chaîne (obligatoire)

Limite de caractères : 1-90

Caractères valides :
Impossibilité d’utiliser :
'<>%&:\?/# ou des caractères de contrôle.
location Emplacement de la ressource. chaîne (obligatoire)
parent_id Pour effectuer un déploiement sur un groupe de ressources, utilisez l’ID de ce groupe de ressources. chaîne (obligatoire)
tags Paires clé-valeur de propriétés supplémentaires pour la ressource. Dictionnaire de noms et de valeurs d’étiquettes.
sku La référence sku détermine le type d’environnement, Gen1 (S1 ou S2) ou Gen2 (L1). Pour les environnements Gen1, la référence sku détermine la capacité de l’environnement, le taux d’entrée et le taux de facturation. Référence SKU (obligatoire)
kind Définir le type d’objet Première génération
Gen2 (obligatoire)

Gen1EnvironmentCreateOrUpdateParametersOrGen1Environ...

Nom Description Valeur
kind Le genre de l’environnement. « Gen1 » (obligatoire)
properties Propriétés utilisées pour créer un environnement Gen1. Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe... (obligatoire)

Gen1EnvironmentCreationPropertiesOrGen1EnvironmentRe...

Nom Description Valeur
dataRetentionTime Intervalle de temps ISO8601 spécifiant le nombre minimal de jours pendant lesquels les événements de l’environnement seront disponibles pour la requête. chaîne (obligatoire)
partitionKeyProperties Liste des propriétés d’événement qui seront utilisées pour partitionner les données dans l’environnement. Actuellement, une seule propriété de clé de partition est prise en charge. TimeSeriesIdProperty[]
storageLimitExceededBehavior Comportement que le service Time Series Insights doit adopter lorsque la capacité de l’environnement a été dépassée. Si « PauseIngress » est spécifié, les nouveaux événements ne seront pas lus à partir de la source de l’événement. Si « PurgeOldData » est spécifié, les nouveaux événements continueront d’être lus et les anciens événements seront supprimés de l’environnement. Le comportement par défaut est PurgeOldData. « PauseIngress »
« PurgeOldData »

TimeSeriesIdProperty

Nom Description Valeur
name Nom de la propriété. string
type Type de la propriété. « String »

Gen2EnvironmentCreateOrUpdateParametersOrGen2Environ...

Nom Description Valeur
kind Le genre de l’environnement. « Gen2 » (obligatoire)
properties Propriétés utilisées pour créer un environnement Gen2. Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe... (obligatoire)

Gen2EnvironmentCreationPropertiesOrGen2EnvironmentRe...

Nom Description Valeur
storageConfiguration La configuration du stockage fournit les détails de connexion qui permettent au service Time Series Insights de se connecter au compte de stockage client utilisé pour stocker les données de l’environnement. Gen2StorageConfigurationInputOrGen2StorageConfigurat... (obligatoire)
timeSeriesIdProperties Liste des propriétés d’événement qui seront utilisées pour définir l’ID de série chronologique de l’environnement. TimeSeriesIdProperty[] (obligatoire)
warmStoreConfiguration La configuration du magasin chaud fournit les détails permettant de créer un cache de magasin chaud qui conservera une copie des données de l’environnement disponibles pour une requête plus rapide. WarmStoreConfigurationProperties

Gen2StorageConfigurationInputOrGen2StorageConfigurat...

Nom Description Valeur
accountName Nom du compte de stockage qui contiendra les données Gen2 de l’environnement. string (obligatoire)
managementKey Valeur de la clé de gestion qui accorde au service Time Series Insights un accès en écriture au compte de stockage. Cette propriété n’est pas affichée dans les réponses d’environnement. string (obligatoire)

WarmStoreConfigurationProperties

Nom Description Valeur
dataRetention Intervalle de temps ISO8601 spécifiant le nombre de jours pendant lesquels les événements de l’environnement seront disponibles pour une requête à partir du magasin chaud. string (obligatoire)

Sku

Nom Description Valeur
capacité Capacité de la référence SKU. Pour les environnements Gen1, cette valeur peut être modifiée pour prendre en charge le scale-out des environnements après leur création. int (obligatoire)
name Nom de cette référence SKU. « L1 »
« P1 »
« S1 »
« S2 » (obligatoire)