Environments - Create Or Update

Crée ou met à jour un environnement dans l’abonnement et le groupe de ressources spécifiés.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}?api-version=2018-08-15-preview

Paramètres URI

Name In Required Type Description
environmentName
path True
  • string

Nom de l’environnement

Regex pattern: ^[-\w\._\(\)]+$

resourceGroupName
path True
  • string

Nom d’un groupe de ressources Azure.

subscriptionId
path True
  • string

ID d’abonnement Azure.

api-version
query True
  • string

Version de l’API à utiliser avec la demande du client.

Corps de la demande

Le corps de la requête peut être l’un des suivants :

Name Description
LongTermEnvironmentCreateOrUpdateParameters

Paramètres fournis à l’opération de création ou de mise à jour d’environnement pour un environnement à long terme.

StandardEnvironmentCreateOrUpdateParameters

Paramètres fournis à l’opération de création ou de mise à jour d’environnement pour un environnement standard.

LongTermEnvironmentCreateOrUpdateParameters

Paramètres fournis à l’opération de création ou de mise à jour d’environnement pour un environnement à long terme.

Name Required Type Description
kind True string:
  • LongTerm

Type de l’environnement.

location True
  • string

Emplacement de la ressource.

properties.storageConfiguration True

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.

properties.timeSeriesIdProperties True

Liste des propriétés d’événement qui sera utilisée pour définir l’ID de série chronologique de l’environnement.

sku True

La référence détermine le type d’environnement, à savoir standard (S1 ou S2) ou à long terme (L1). Pour les environnements standard, la référence détermine la capacité de l’environnement, le taux d’entrée et le taux de facturation.

properties.warmStoreConfiguration

La configuration du magasin à chaud fournit les détails pour créer un cache de magasin chaud qui conserve une copie des données de l’environnement disponible pour une requête plus rapide.

tags
  • object

Paires clé-valeur de propriétés supplémentaires pour la ressource.

StandardEnvironmentCreateOrUpdateParameters

Paramètres fournis à l’opération de création ou de mise à jour d’environnement pour un environnement standard.

Name Required Type Description
kind True string:
  • Standard

Type de l’environnement.

location True
  • string

Emplacement de la ressource.

properties.dataRetentionTime True
  • string

ISO8601 TimeSpan spécifiant le nombre minimal de jours pendant lesquels les événements de l’environnement seront disponibles pour la requête.

sku True

La référence détermine le type d’environnement, à savoir standard (S1 ou S2) ou à long terme (L1). Pour les environnements standard, la référence détermine la capacité de l’environnement, le taux d’entrée et le taux de facturation.

properties.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.

properties.storageLimitExceededBehavior

Comportement que le service Time Series Insights doit prendre lorsque la capacité de l’environnement est 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 continuent à être lus et les anciens événements sont supprimés de l’environnement. Le comportement par défaut est PurgeOldData.

tags
  • object

Paires clé-valeur de propriétés supplémentaires pour la ressource.

Réponses

Name Type Description
200 OK EnvironmentResource:

La définition de l’environnement existante a été correctement mise à jour.

201 Created EnvironmentResource:

La demande de création d’environnement a été acceptée. L’approvisionnement d’environnement est une opération asynchrone. Vous pouvez récupérer régulièrement la définition de votre environnement et surveiller la progression via la propriété provisioningState.

404 Not Found

L’abonnement ou le groupe de ressources est introuvable.

Other Status Codes

HTTP 400 (requête incorrecte) : le corps de la demande d’environnement spécifié n’est pas valide ; Pour plus d’informations, consultez le code d’erreur et le message dans la réponse.

Sécurité

azure_auth

Azure Active Directory le Flow OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

EnvironmentsCreate

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/environments/env1?api-version=2018-08-15-preview
{
  "location": "West US",
  "kind": "Standard",
  "sku": {
    "name": "S1",
    "capacity": 1
  },
  "properties": {
    "dataRetentionTime": "P31D",
    "partitionKeyProperties": [
      {
        "name": "DeviceId1",
        "type": "String"
      }
    ]
  }
}

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1",
  "location": "West US",
  "name": "env1",
  "type": "Microsoft.TimeSeriesInsights/Environments",
  "kind": "Standard",
  "tags": {},
  "properties": {
    "dataRetentionTime": "P31D",
    "provisioningState": "Creating",
    "creationTime": "2017-04-18T19:20:33.2288820Z"
  },
  "sku": {
    "name": "S1",
    "capacity": 1
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1",
  "location": "West US",
  "name": "env1",
  "type": "Microsoft.TimeSeriesInsights/Environments",
  "kind": "Standard",
  "tags": {},
  "properties": {
    "dataRetentionTime": "P31D",
    "provisioningState": "Succeeded",
    "creationTime": "2017-04-18T19:20:33.2288820Z"
  },
  "sku": {
    "name": "S1",
    "capacity": 1
  }
}

Définitions

CloudError

Contient des informations sur une erreur d’API.

CloudErrorBody

Décrit une erreur d’API particulière avec un code d’erreur et un message.

EnvironmentStateDetails

Objet qui contient les détails de l’état d’un environnement.

EnvironmentStatus

Objet qui représente l’état de l’environnement et son état interne dans le service de Time Series Insights.

IngressEnvironmentStatus

Objet qui représente l’état d’entrée sur un environnement.

IngressState

Cette chaîne représente l’état des opérations d’entrée sur un environnement. Il peut être « désactivé », « prêt », « en cours d’exécution », « suspendu » ou « inconnu ».

LongTermEnvironmentCreateOrUpdateParameters

Paramètres fournis à l’opération de création ou de mise à jour d’environnement pour un environnement à long terme.

LongTermEnvironmentResource

Un environnement est un ensemble de données de séries chronologiques disponibles pour la requête. il s’agit de la ressource de niveau supérieur Azure Time Series Insights. Les environnements LongTerm n’ont pas de limite de rétention des données définie.

LongTermStorageConfigurationInput

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.

LongTermStorageConfigurationOutput

La configuration du stockage fournit les détails de connexion non-secret sur le compte de stockage client utilisé pour stocker les données de l’environnement.

PropertyType

Type de la propriété.

ProvisioningState

État d’approvisionnement de la ressource.

Sku

La référence détermine le type d’environnement, à savoir standard (S1 ou S2) ou à long terme (L1). Pour les environnements standard, la référence détermine la capacité de l’environnement, le taux d’entrée et le taux de facturation.

SkuName

Nom de cette référence (SKU).

StandardEnvironmentCreateOrUpdateParameters

Paramètres fournis à l’opération de création ou de mise à jour d’environnement pour un environnement standard.

StandardEnvironmentResource

Un environnement est un ensemble de données de séries chronologiques disponibles pour la requête. il s’agit de la ressource de niveau supérieur Azure Time Series Insights. Les environnements standard ont des limites de rétention des données.

StorageLimitExceededBehavior

Comportement que le service Time Series Insights doit prendre lorsque la capacité de l’environnement est 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 continuent à être lus et les anciens événements sont supprimés de l’environnement. Le comportement par défaut est PurgeOldData.

TimeSeriesIdProperty

Structure de la propriété qu’un ID de série chronologique peut avoir. Un environnement peut avoir plusieurs propriétés de ce type.

WarmStorageEnvironmentStatus

Objet qui représente l’état du stockage à chaud sur un environnement.

WarmStoragePropertiesState

Cette chaîne représente l’état de l’utilisation des propriétés de stockage semi-automatique. Il peut s’agir de « OK », « erreur », « inconnu ».

WarmStoreConfigurationProperties

La configuration du magasin à chaud fournit les détails pour créer un cache de magasin chaud qui conserve une copie des données de l’environnement disponible pour une requête plus rapide.

CloudError

Contient des informations sur une erreur d’API.

Name Type Description
error

Décrit une erreur d’API particulière avec un code d’erreur et un message.

CloudErrorBody

Décrit une erreur d’API particulière avec un code d’erreur et un message.

Name Type Description
code
  • string

Code d’erreur qui décrit la condition d’erreur plus précisément qu’un code d’état HTTP. Peut être utilisé pour gérer par programmation des cas d’erreur spécifiques.

details

Contient des erreurs imbriquées liées à cette erreur.

message
  • string

Message qui décrit l’erreur en détail et fournit des informations de débogage.

target
  • string

Cible de l’erreur particulière (par exemple, le nom de la propriété dans l’erreur).

EnvironmentStateDetails

Objet qui contient les détails de l’état d’un environnement.

Name Type Description
code
  • string

Contient le code qui représente la raison pour laquelle un environnement est dans un état particulier. Peut être utilisé pour gérer par programme des cas spécifiques.

message
  • string

Message qui décrit l’État en détail.

EnvironmentStatus

Objet qui représente l’état de l’environnement et son état interne dans le service de Time Series Insights.

Name Type Description
ingress

Objet qui représente l’état d’entrée sur un environnement.

warmStorage

Objet qui représente l’état du stockage à chaud sur un environnement.

IngressEnvironmentStatus

Objet qui représente l’état d’entrée sur un environnement.

Name Type Description
state

Cette chaîne représente l’état des opérations d’entrée sur un environnement. Il peut être « désactivé », « prêt », « en cours d’exécution », « suspendu » ou « inconnu ».

stateDetails

Objet qui contient les détails de l’état d’un environnement.

IngressState

Cette chaîne représente l’état des opérations d’entrée sur un environnement. Il peut être « désactivé », « prêt », « en cours d’exécution », « suspendu » ou « inconnu ».

Name Type Description
Disabled
  • string
Paused
  • string
Ready
  • string
Running
  • string
Unknown
  • string

LongTermEnvironmentCreateOrUpdateParameters

Paramètres fournis à l’opération de création ou de mise à jour d’environnement pour un environnement à long terme.

Name Type Description
kind string:
  • LongTerm

Type de l’environnement.

location
  • string

Emplacement de la ressource.

properties.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.

properties.timeSeriesIdProperties

Liste des propriétés d’événement qui sera utilisée pour définir l’ID de série chronologique de l’environnement.

properties.warmStoreConfiguration

La configuration du magasin à chaud fournit les détails pour créer un cache de magasin chaud qui conserve une copie des données de l’environnement disponible pour une requête plus rapide.

sku

La référence détermine le type d’environnement, à savoir standard (S1 ou S2) ou à long terme (L1). Pour les environnements standard, la référence détermine la capacité de l’environnement, le taux d’entrée et le taux de facturation.

tags
  • object

Paires clé-valeur de propriétés supplémentaires pour la ressource.

LongTermEnvironmentResource

Un environnement est un ensemble de données de séries chronologiques disponibles pour la requête. il s’agit de la ressource de niveau supérieur Azure Time Series Insights. Les environnements LongTerm n’ont pas de limite de rétention des données définie.

Name Type Description
creationTime
  • string

Heure à laquelle la ressource a été créée.

id
  • string

ID de ressource

kind string:
  • LongTerm

Type de l’environnement.

location
  • string

Emplacement de la ressource

name
  • string

Nom de la ressource

properties.creationTime
  • string

Heure à laquelle la ressource a été créée.

properties.dataAccessFqdn
  • string

Nom de domaine complet utilisé pour accéder aux données de l’environnement, par exemple pour interroger les événements de l’environnement ou charger des données de référence pour l’environnement.

properties.dataAccessId
  • string

ID utilisé pour accéder aux données de l’environnement, par exemple pour interroger les événements de l’environnement ou charger des données de référence pour l’environnement.

properties.provisioningState

État d’approvisionnement de la ressource.

properties.status

Objet qui représente l’état de l’environnement et son état interne dans le service de Time Series Insights.

properties.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.

properties.timeSeriesIdProperties

Liste des propriétés d’événement qui sera utilisée pour définir l’ID de série chronologique de l’environnement.

properties.warmStoreConfiguration

La configuration du magasin à chaud fournit les détails pour créer un cache de magasin chaud qui conserve une copie des données de l’environnement disponible pour une requête plus rapide.

provisioningState

État d’approvisionnement de la ressource.

sku

La référence détermine le type d’environnement, à savoir standard (S1 ou S2) ou à long terme (L1). Pour les environnements standard, la référence détermine la capacité de l’environnement, le taux d’entrée et le taux de facturation.

tags
  • object

Balises de ressource

type
  • string

Type de ressource

LongTermStorageConfigurationInput

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.

Name Type Description
accountName
  • string

Nom du compte de stockage qui contiendra les données à long terme de l’environnement.

managementKey
  • string

Valeur de la clé de gestion qui accorde au service Time Series Insights l’accès en écriture au compte de stockage. Cette propriété n’est pas indiquée dans les réponses d’environnement.

LongTermStorageConfigurationOutput

La configuration du stockage fournit les détails de connexion non-secret sur le compte de stockage client utilisé pour stocker les données de l’environnement.

Name Type Description
accountName
  • string

Nom du compte de stockage qui contiendra les données à long terme de l’environnement.

PropertyType

Type de la propriété.

Name Type Description
String
  • string

ProvisioningState

État d’approvisionnement de la ressource.

Name Type Description
Accepted
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

Sku

La référence détermine le type d’environnement, à savoir standard (S1 ou S2) ou à long terme (L1). Pour les environnements standard, la référence détermine la capacité de l’environnement, le taux d’entrée et le taux de facturation.

Name Type Description
capacity
  • integer

Capacité de la référence (SKU). Pour les environnements standard, cette valeur peut être modifiée pour prendre en charge la mise à l’échelle des environnements après leur création.

name

Nom de cette référence (SKU).

SkuName

Nom de cette référence (SKU).

Name Type Description
L1
  • string
P1
  • string
S1
  • string
S2
  • string

StandardEnvironmentCreateOrUpdateParameters

Paramètres fournis à l’opération de création ou de mise à jour d’environnement pour un environnement standard.

Name Type Description
kind string:
  • Standard

Type de l’environnement.

location
  • string

Emplacement de la ressource.

properties.dataRetentionTime
  • string

ISO8601 TimeSpan spécifiant le nombre minimal de jours pendant lesquels les événements de l’environnement seront disponibles pour la requête.

properties.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.

properties.storageLimitExceededBehavior

Comportement que le service Time Series Insights doit prendre lorsque la capacité de l’environnement est 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 continuent à être lus et les anciens événements sont supprimés de l’environnement. Le comportement par défaut est PurgeOldData.

sku

La référence détermine le type d’environnement, à savoir standard (S1 ou S2) ou à long terme (L1). Pour les environnements standard, la référence détermine la capacité de l’environnement, le taux d’entrée et le taux de facturation.

tags
  • object

Paires clé-valeur de propriétés supplémentaires pour la ressource.

StandardEnvironmentResource

Un environnement est un ensemble de données de séries chronologiques disponibles pour la requête. il s’agit de la ressource de niveau supérieur Azure Time Series Insights. Les environnements standard ont des limites de rétention des données.

Name Type Description
creationTime
  • string

Heure à laquelle la ressource a été créée.

id
  • string

ID de ressource

kind string:
  • Standard

Type de l’environnement.

location
  • string

Emplacement de la ressource

name
  • string

Nom de la ressource

properties.creationTime
  • string

Heure à laquelle la ressource a été créée.

properties.dataAccessFqdn
  • string

Nom de domaine complet utilisé pour accéder aux données de l’environnement, par exemple pour interroger les événements de l’environnement ou charger des données de référence pour l’environnement.

properties.dataAccessId
  • string

ID utilisé pour accéder aux données de l’environnement, par exemple pour interroger les événements de l’environnement ou charger des données de référence pour l’environnement.

properties.dataRetentionTime
  • string

ISO8601 TimeSpan spécifiant le nombre minimal de jours pendant lesquels les événements de l’environnement seront disponibles pour la requête.

properties.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.

properties.provisioningState

État d’approvisionnement de la ressource.

properties.status

Objet qui représente l’état de l’environnement et son état interne dans le service de Time Series Insights.

properties.storageLimitExceededBehavior

Comportement que le service Time Series Insights doit prendre lorsque la capacité de l’environnement est 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 continuent à être lus et les anciens événements sont supprimés de l’environnement. Le comportement par défaut est PurgeOldData.

provisioningState

État d’approvisionnement de la ressource.

sku

La référence détermine le type d’environnement, à savoir standard (S1 ou S2) ou à long terme (L1). Pour les environnements standard, la référence détermine la capacité de l’environnement, le taux d’entrée et le taux de facturation.

tags
  • object

Balises de ressource

type
  • string

Type de ressource

StorageLimitExceededBehavior

Comportement que le service Time Series Insights doit prendre lorsque la capacité de l’environnement est 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 continuent à être lus et les anciens événements sont supprimés de l’environnement. Le comportement par défaut est PurgeOldData.

Name Type Description
PauseIngress
  • string
PurgeOldData
  • string

TimeSeriesIdProperty

Structure de la propriété qu’un ID de série chronologique peut avoir. Un environnement peut avoir plusieurs propriétés de ce type.

Name Type Description
name
  • string

Nom de la propriété.

type

Type de la propriété.

WarmStorageEnvironmentStatus

Objet qui représente l’état du stockage à chaud sur un environnement.

Name Type Description
propertiesUsage.state

Cette chaîne représente l’état de l’utilisation des propriétés de stockage semi-automatique. Il peut s’agir de « OK », « erreur », « inconnu ».

propertiesUsage.stateDetails.currentCount
  • integer

Valeur qui représente le nombre de propriétés utilisées par l’environnement pour la référence (SKU) S1/S2 et le nombre de propriétés utilisées par le magasin à chaud pour la référence (SKU) PAYG

propertiesUsage.stateDetails.maxCount
  • integer

Valeur qui représente le nombre maximal de propriétés utilisées par l’environnement pour la référence S1/S2 et le nombre maximal de propriétés autorisées par le magasin à chaud pour la référence (SKU) PAYG.

WarmStoragePropertiesState

Cette chaîne représente l’état de l’utilisation des propriétés de stockage semi-automatique. Il peut s’agir de « OK », « erreur », « inconnu ».

Name Type Description
Error
  • string
Ok
  • string
Unknown
  • string

WarmStoreConfigurationProperties

La configuration du magasin à chaud fournit les détails pour créer un cache de magasin chaud qui conserve une copie des données de l’environnement disponible pour une requête plus rapide.

Name Type Description
dataRetention
  • string

ISO8601 TimeSpan spécifiant le nombre de jours pendant lesquels les événements de l’environnement seront disponibles pour la requête à partir du magasin à chaud.