Environments - Create Or Update
Créez ou mettez à 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=2020-05-15
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
environment
|
path | True |
string |
Nom de l’environnement Regex pattern: |
resource
|
path | True |
string |
Nom d’un groupe de ressources Azure. |
subscription
|
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 :
Nom | Description |
---|---|
Gen1Environment |
Paramètres fournis à l’opération Créer ou mettre à jour un environnement pour un environnement Gen1. |
Gen2Environment |
Paramètres fournis à l’opération Créer ou mettre à jour un environnement pour un environnement Gen2. |
Gen1EnvironmentCreateOrUpdateParameters
Paramètres fournis à l’opération Créer ou mettre à jour un environnement pour un environnement Gen1.
Nom | Obligatoire | Type | Description |
---|---|---|---|
kind | True |
string:
Gen1 |
Le type de l’environnement. |
location | True |
string |
Emplacement de la ressource. |
properties.dataRetentionTime | True |
string |
ISO8601 intervalle de temps 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 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. |
|
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 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. |
||
tags |
object |
Paires clé-valeur de propriétés supplémentaires pour la ressource. |
Gen2EnvironmentCreateOrUpdateParameters
Paramètres fournis à l’opération Créer ou mettre à jour un environnement pour un environnement Gen2.
Nom | Obligatoire | Type | Description |
---|---|---|---|
kind | True |
string:
Gen2 |
Le 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 seront utilisées pour définir l’ID de série chronologique de l’environnement. |
|
sku | True |
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. |
|
properties.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. |
||
tags |
object |
Paires clé-valeur de propriétés supplémentaires pour la ressource. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK | EnvironmentResource: |
La définition d’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 obtenir régulièrement votre définition d’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 donné n’est pas valide ; Pour plus d’informations, consultez le code d’erreur et le message dans la réponse. |
Sécurité
azure_auth
Flux OAuth2 Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nom | 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=2020-05-15
{
"location": "West US",
"kind": "Gen1",
"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": "Gen1",
"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": "Gen1",
"tags": {},
"properties": {
"dataRetentionTime": "P31D",
"provisioningState": "Succeeded",
"creationTime": "2017-04-18T19:20:33.2288820Z"
},
"sku": {
"name": "S1",
"capacity": 1
}
}
Définitions
Nom | Description |
---|---|
Cloud |
Contient des informations sur une erreur d’API. |
Cloud |
Décrit une erreur d’API particulière avec un code d’erreur et un message. |
Environment |
Objet qui contient les détails de l’état d’un environnement. |
Environment |
Objet qui représente le status de l’environnement et son état interne dans le service Time Series Insights. |
Gen1Environment |
Paramètres fournis à l’opération Créer ou mettre à jour un environnement pour un environnement Gen1. |
Gen1Environment |
Un environnement est un ensemble de données de série chronologique disponibles pour la requête et constitue le niveau supérieur Azure Time Series Insights ressource. Les environnements Gen1 ont des limites de rétention des données. |
Gen2Environment |
Paramètres fournis à l’opération Créer ou mettre à jour un environnement pour un environnement Gen2. |
Gen2Environment |
Un environnement est un ensemble de données de série chronologique disponibles pour la requête et constitue le niveau supérieur Azure Time Series Insights ressource. Les environnements Gen2 n’ont pas de limites de rétention des données définies. |
Gen2Storage |
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. |
Gen2Storage |
La configuration du stockage fournit les détails de connexion non secrets sur le compte de stockage client utilisé pour stocker les données de l’environnement. |
Ingress |
Objet qui représente le status d’entrée sur un environnement. |
Ingress |
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 » |
Property |
Type de la propriété. |
Provisioning |
État d’approvisionnement de la ressource. |
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. |
Sku |
Nom de cette référence SKU. |
Storage |
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. |
Time |
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. |
Warm |
Objet qui représente le status de stockage chaud sur un environnement. |
Warm |
Cette chaîne représente l’état de l’utilisation des propriétés de stockage à chaud. Il peut s’agir de « Ok », « Erreur », « Inconnu ». |
Warm |
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. |
CloudError
Contient des informations sur une erreur d’API.
Nom | 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.
Nom | Type | Description |
---|---|---|
code |
string |
Code d’erreur qui décrit la condition d’erreur plus précisément qu’un code status 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.
Nom | Type | Description |
---|---|---|
code |
string |
Contient le code qui représente la raison pour laquelle un environnement se trouve dans un état particulier. Peut être utilisé pour gérer des cas spécifiques par programmation. |
message |
string |
Message qui décrit l’état en détail. |
EnvironmentStatus
Objet qui représente le status de l’environnement et son état interne dans le service Time Series Insights.
Nom | Type | Description |
---|---|---|
ingress |
Objet qui représente le status d’entrée sur un environnement. |
|
warmStorage |
Objet qui représente le status de stockage chaud sur un environnement. |
Gen1EnvironmentCreateOrUpdateParameters
Paramètres fournis à l’opération Créer ou mettre à jour un environnement pour un environnement Gen1.
Nom | Type | Description |
---|---|---|
kind |
string:
Gen1 |
Le type de l’environnement. |
location |
string |
Emplacement de la ressource. |
properties.dataRetentionTime |
string |
ISO8601 intervalle de temps 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 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. |
|
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. |
|
tags |
object |
Paires clé-valeur de propriétés supplémentaires pour la ressource. |
Gen1EnvironmentResource
Un environnement est un ensemble de données de série chronologique disponibles pour la requête et constitue le niveau supérieur Azure Time Series Insights ressource. Les environnements Gen1 ont des limites de rétention des données.
Nom | Type | Description |
---|---|---|
creationTime |
string |
Heure à laquelle la ressource a été créée. |
id |
string |
ID de ressource |
kind |
string:
Gen1 |
Le type de l’environnement. |
location |
string |
Emplacement de la ressource |
name |
string |
Nom de la ressource |
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 intervalle de temps 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.status |
Objet qui représente le status de l’environnement et son état interne dans le service Time Series Insights. |
|
properties.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. |
|
provisioningState |
État d’approvisionnement de la ressource. |
|
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. |
|
tags |
object |
Balises de ressource |
type |
string |
Type de ressource |
Gen2EnvironmentCreateOrUpdateParameters
Paramètres fournis à l’opération Créer ou mettre à jour un environnement pour un environnement Gen2.
Nom | Type | Description |
---|---|---|
kind |
string:
Gen2 |
Le 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 seront utilisées pour définir l’ID de série chronologique de l’environnement. |
|
properties.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. |
|
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. |
|
tags |
object |
Paires clé-valeur de propriétés supplémentaires pour la ressource. |
Gen2EnvironmentResource
Un environnement est un ensemble de données de série chronologique disponibles pour la requête et constitue le niveau supérieur Azure Time Series Insights ressource. Les environnements Gen2 n’ont pas de limites de rétention des données définies.
Nom | Type | Description |
---|---|---|
creationTime |
string |
Heure à laquelle la ressource a été créée. |
id |
string |
ID de ressource |
kind |
string:
Gen2 |
Le type de l’environnement. |
location |
string |
Emplacement de la ressource |
name |
string |
Nom de la ressource |
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.status |
Objet qui représente le status de l’environnement et son état interne dans le service 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 seront utilisées pour définir l’ID de série chronologique de l’environnement. |
|
properties.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. |
|
provisioningState |
État d’approvisionnement de la ressource. |
|
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. |
|
tags |
object |
Balises de ressource |
type |
string |
Type de ressource |
Gen2StorageConfigurationInput
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.
Nom | Type | Description |
---|---|---|
accountName |
string |
Nom du compte de stockage qui contiendra les données Gen2 de l’environnement. |
managementKey |
string |
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. |
Gen2StorageConfigurationOutput
La configuration du stockage fournit les détails de connexion non secrets sur le compte de stockage client utilisé pour stocker les données de l’environnement.
Nom | Type | Description |
---|---|---|
accountName |
string |
Nom du compte de stockage qui contiendra les données Gen2 de l’environnement. |
IngressEnvironmentStatus
Objet qui représente le status d’entrée sur un environnement.
Nom | 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 »
Nom | Type | Description |
---|---|---|
Disabled |
string |
|
Paused |
string |
|
Ready |
string |
|
Running |
string |
|
Unknown |
string |
PropertyType
Type de la propriété.
Nom | Type | Description |
---|---|---|
String |
string |
ProvisioningState
État d’approvisionnement de la ressource.
Nom | Type | Description |
---|---|---|
Accepted |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
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.
Nom | Type | Description |
---|---|---|
capacity |
integer |
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. |
name |
Nom de cette référence SKU. |
SkuName
Nom de cette référence SKU.
Nom | Type | Description |
---|---|---|
L1 |
string |
|
P1 |
string |
|
S1 |
string |
|
S2 |
string |
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.
Nom | 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.
Nom | Type | Description |
---|---|---|
name |
string |
Nom de la propriété. |
type |
Type de la propriété. |
WarmStorageEnvironmentStatus
Objet qui représente le status de stockage chaud sur un environnement.
Nom | Type | Description |
---|---|---|
propertiesUsage.state |
Cette chaîne représente l’état de l’utilisation des propriétés de stockage à chaud. 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 warm Store pour la référence SKU PAYG |
propertiesUsage.stateDetails.maxCount |
integer |
Valeur qui représente le nombre maximal de propriétés utilisées autorisées par l’environnement pour la référence SKU 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 à chaud. Il peut s’agir de « Ok », « Erreur », « Inconnu ».
Nom | Type | Description |
---|---|---|
Error |
string |
|
Ok |
string |
|
Unknown |
string |
WarmStoreConfigurationProperties
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.
Nom | Type | Description |
---|---|---|
dataRetention |
string |
ISO8601 intervalle de temps spécifiant le nombre de jours pendant lesquels les événements de l’environnement seront disponibles pour une requête à partir du magasin chaud. |