Environments - Create Or Update

Crie ou atualize um ambiente na assinatura e no grupo de recursos especificados.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
environmentName
path True

string

Nome do ambiente

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

resourceGroupName
path True

string

Nome de um grupo de recursos do Azure.

subscriptionId
path True

string

ID de assinatura do Azure.

api-version
query True

string

Versão da API a ser usada com a solicitação do cliente.

Corpo da solicitação

O corpo da solicitação pode ser um dos seguintes:

Nome Description
Gen1EnvironmentCreateOrUpdateParameters

Parâmetros fornecidos para a operação Criar ou Atualizar Ambiente para um ambiente Gen1.

Gen2EnvironmentCreateOrUpdateParameters

Parâmetros fornecidos para a operação Criar ou Atualizar Ambiente para um ambiente Gen2.

Gen1EnvironmentCreateOrUpdateParameters

Parâmetros fornecidos para a operação Criar ou Atualizar Ambiente para um ambiente Gen1.

Nome Obrigatório Tipo Description
kind True string:

Gen1

O tipo de ambiente.

location True

string

A localização do recurso.

properties.dataRetentionTime True

string

ISO8601 período especificando o número mínimo de dias em que os eventos do ambiente estarão disponíveis para consulta.

sku True

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.

properties.partitionKeyProperties

TimeSeriesIdProperty[]

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.

properties.storageLimitExceededBehavior

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.

tags

object

Pares chave-valor de propriedades adicionais para o recurso.

Gen2EnvironmentCreateOrUpdateParameters

Parâmetros fornecidos para a operação Criar ou Atualizar Ambiente para um ambiente Gen2.

Nome Obrigatório Tipo Description
kind True string:

Gen2

O tipo de ambiente.

location True

string

A localização do recurso.

properties.storageConfiguration True

Gen2StorageConfigurationInput

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.

properties.timeSeriesIdProperties True

TimeSeriesIdProperty[]

A lista de propriedades de evento que serão usadas para definir a ID da série temporal do ambiente.

sku True

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.

properties.warmStoreConfiguration

WarmStoreConfigurationProperties

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.

tags

object

Pares chave-valor de propriedades adicionais para o recurso.

Respostas

Nome Tipo Description
200 OK EnvironmentResource:

A definição de ambiente existente foi atualizada com êxito.

201 Created EnvironmentResource:

A solicitação de criação de ambiente foi aceita. O provisionamento de ambiente é uma operação assíncrona. Você pode obter periodicamente sua definição de ambiente e monitorar o progresso por meio da propriedade provisioningState.

404 Not Found

Não foi possível encontrar a assinatura ou o grupo de recursos.

Other Status Codes

CloudError

HTTP 400 (solicitação incorreta): o corpo da solicitação de ambiente especificado é inválido; Consulte o código de erro e a mensagem na resposta para obter detalhes.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

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
  }
}

Definições

Nome Description
CloudError

Contém informações sobre um erro de API.

CloudErrorBody

Descreve um erro de API específico com um código de erro e uma mensagem.

EnvironmentStateDetails

Um objeto que contém os detalhes sobre o estado de um ambiente.

EnvironmentStatus

Um objeto que representa o status do ambiente e seu estado interno no serviço Time Series Insights.

Gen1EnvironmentCreateOrUpdateParameters

Parâmetros fornecidos para a operação Criar ou Atualizar Ambiente para um ambiente Gen1.

Gen1EnvironmentResource

Um ambiente é um conjunto de dados de série temporal disponíveis para consulta e é o recurso de Azure Time Series Insights de nível superior. Os ambientes gen1 têm limites de retenção de dados.

Gen2EnvironmentCreateOrUpdateParameters

Parâmetros fornecidos para a operação Criar ou Atualizar Ambiente para um ambiente Gen2.

Gen2EnvironmentResource

Um ambiente é um conjunto de dados de série temporal disponíveis para consulta e é o recurso de Azure Time Series Insights de nível superior. Os ambientes gen2 não têm limites de retenção de dados definidos.

Gen2StorageConfigurationInput

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.

Gen2StorageConfigurationOutput

A configuração de armazenamento fornece os detalhes da conexão não secreta sobre a conta de armazenamento do cliente usada para armazenar os dados do ambiente.

IngressEnvironmentStatus

Um objeto que representa o status de entrada em um ambiente.

IngressState

Essa cadeia de caracteres representa o estado das operações de entrada em um ambiente. Pode ser "Desabilitado", "Pronto", "Em Execução", "Pausado" ou "Desconhecido"

PropertyType

O tipo da propriedade.

ProvisioningState

Estado de provisionamento do recurso.

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.

SkuName

O nome desse SKU.

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.

TimeSeriesIdProperty

A estrutura da propriedade que uma ID de série temporal pode ter. Um ambiente pode ter várias dessas propriedades.

WarmStorageEnvironmentStatus

Um objeto que representa o status de armazenamento warm em um ambiente.

WarmStoragePropertiesState

Essa cadeia de caracteres representa o estado do uso de propriedades de armazenamento warm. Pode ser "Ok", "Erro", "Desconhecido".

WarmStoreConfigurationProperties

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.

CloudError

Contém informações sobre um erro de API.

Nome Tipo Description
error

CloudErrorBody

Descreve um erro de API específico com um código de erro e uma mensagem.

CloudErrorBody

Descreve um erro de API específico com um código de erro e uma mensagem.

Nome Tipo Description
code

string

Um código de erro que descreve a condição de erro com mais precisão do que um código de status HTTP. Pode ser usado para lidar programaticamente com casos de erro específicos.

details

CloudErrorBody[]

Contém erros aninhados relacionados a esse erro.

message

string

Uma mensagem que descreve o erro em detalhes e fornece informações de depuração.

target

string

O destino do erro específico (por exemplo, o nome da propriedade em erro).

EnvironmentStateDetails

Um objeto que contém os detalhes sobre o estado de um ambiente.

Nome Tipo Description
code

string

Contém o código que representa o motivo de um ambiente estar em um estado específico. Pode ser usado para lidar programaticamente com casos específicos.

message

string

Uma mensagem que descreve o estado em detalhes.

EnvironmentStatus

Um objeto que representa o status do ambiente e seu estado interno no serviço Time Series Insights.

Nome Tipo Description
ingress

IngressEnvironmentStatus

Um objeto que representa o status de entrada em um ambiente.

warmStorage

WarmStorageEnvironmentStatus

Um objeto que representa o status de armazenamento quente em um ambiente.

Gen1EnvironmentCreateOrUpdateParameters

Parâmetros fornecidos para a operação Criar ou Atualizar Ambiente para um ambiente Gen1.

Nome Tipo Description
kind string:

Gen1

O tipo do ambiente.

location

string

A localização do recurso.

properties.dataRetentionTime

string

ISO8601 período de tempo especificando o número mínimo de dias em que os eventos do ambiente estarão disponíveis para consulta.

properties.partitionKeyProperties

TimeSeriesIdProperty[]

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.

properties.storageLimitExceededBehavior

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.

sku

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.

tags

object

Pares chave-valor de propriedades adicionais para o recurso.

Gen1EnvironmentResource

Um ambiente é um conjunto de dados de série temporal disponíveis para consulta e é o recurso de Azure Time Series Insights de nível superior. Os ambientes gen1 têm limites de retenção de dados.

Nome Tipo Description
creationTime

string

A hora em que o recurso foi criado.

id

string

ID do recurso

kind string:

Gen1

O tipo do ambiente.

location

string

Localização do recurso

name

string

Nome do recurso

properties.dataAccessFqdn

string

O nome de domínio totalmente qualificado usado para acessar os dados do ambiente, por exemplo, para consultar os eventos do ambiente ou carregar dados de referência para o ambiente.

properties.dataAccessId

string

Uma ID usada para acessar os dados do ambiente, por exemplo, para consultar os eventos do ambiente ou carregar dados de referência para o ambiente.

properties.dataRetentionTime

string

ISO8601 período de tempo especificando o número mínimo de dias em que os eventos do ambiente estarão disponíveis para consulta.

properties.partitionKeyProperties

TimeSeriesIdProperty[]

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.

properties.status

EnvironmentStatus

Um objeto que representa o status do ambiente e seu estado interno no serviço Time Series Insights.

properties.storageLimitExceededBehavior

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.

provisioningState

ProvisioningState

Estado de provisionamento do recurso.

sku

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.

tags

object

Marcações de recursos

type

string

Tipo de recurso

Gen2EnvironmentCreateOrUpdateParameters

Parâmetros fornecidos para a operação Criar ou Atualizar Ambiente para um ambiente Gen2.

Nome Tipo Description
kind string:

Gen2

O tipo do ambiente.

location

string

A localização do recurso.

properties.storageConfiguration

Gen2StorageConfigurationInput

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.

properties.timeSeriesIdProperties

TimeSeriesIdProperty[]

A lista de propriedades de evento que serão usadas para definir a ID da série temporal do ambiente.

properties.warmStoreConfiguration

WarmStoreConfigurationProperties

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.

sku

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.

tags

object

Pares chave-valor de propriedades adicionais para o recurso.

Gen2EnvironmentResource

Um ambiente é um conjunto de dados de série temporal disponíveis para consulta e é o recurso de Azure Time Series Insights de nível superior. Os ambientes gen2 não têm limites de retenção de dados definidos.

Nome Tipo Description
creationTime

string

A hora em que o recurso foi criado.

id

string

ID do recurso

kind string:

Gen2

O tipo do ambiente.

location

string

Localização do recurso

name

string

Nome do recurso

properties.dataAccessFqdn

string

O nome de domínio totalmente qualificado usado para acessar os dados do ambiente, por exemplo, para consultar os eventos do ambiente ou carregar dados de referência para o ambiente.

properties.dataAccessId

string

Uma ID usada para acessar os dados do ambiente, por exemplo, para consultar os eventos do ambiente ou carregar dados de referência para o ambiente.

properties.status

EnvironmentStatus

Um objeto que representa o status do ambiente e seu estado interno no serviço Time Series Insights.

properties.storageConfiguration

Gen2StorageConfigurationOutput

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.

properties.timeSeriesIdProperties

TimeSeriesIdProperty[]

A lista de propriedades de evento que serão usadas para definir a ID da série temporal do ambiente.

properties.warmStoreConfiguration

WarmStoreConfigurationProperties

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.

provisioningState

ProvisioningState

Estado de provisionamento do recurso.

sku

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.

tags

object

Marcações de recursos

type

string

Tipo de recurso

Gen2StorageConfigurationInput

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.

Nome Tipo Description
accountName

string

O nome da conta de armazenamento que armazenará os dados gen2 do ambiente.

managementKey

string

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.

Gen2StorageConfigurationOutput

A configuração de armazenamento fornece os detalhes da conexão não secreta sobre a conta de armazenamento do cliente usada para armazenar os dados do ambiente.

Nome Tipo Description
accountName

string

O nome da conta de armazenamento que armazenará os dados gen2 do ambiente.

IngressEnvironmentStatus

Um objeto que representa o status de entrada em um ambiente.

Nome Tipo Description
state

IngressState

Essa cadeia de caracteres representa o estado das operações de entrada em um ambiente. Pode ser "Desabilitado", "Pronto", "Em Execução", "Pausado" ou "Desconhecido"

stateDetails

EnvironmentStateDetails

Um objeto que contém os detalhes sobre o estado de um ambiente.

IngressState

Essa cadeia de caracteres representa o estado das operações de entrada em um ambiente. Pode ser "Desabilitado", "Pronto", "Em Execução", "Pausado" ou "Desconhecido"

Nome Tipo Description
Disabled

string

Paused

string

Ready

string

Running

string

Unknown

string

PropertyType

O tipo da propriedade.

Nome Tipo Description
String

string

ProvisioningState

Estado de provisionamento do recurso.

Nome Tipo Description
Accepted

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

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.

Nome Tipo Description
capacity

integer

A capacidade do sku. Para ambientes Gen1, esse valor pode ser alterado para dar suporte à expansão de ambientes depois de terem sido criados.

name

SkuName

O nome desse SKU.

SkuName

O nome desse SKU.

Nome Tipo Description
L1

string

P1

string

S1

string

S2

string

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.

Nome Tipo Description
PauseIngress

string

PurgeOldData

string

TimeSeriesIdProperty

A estrutura da propriedade que uma ID de série temporal pode ter. Um ambiente pode ter várias dessas propriedades.

Nome Tipo Description
name

string

O nome da propriedade.

type

PropertyType

O tipo da propriedade.

WarmStorageEnvironmentStatus

Um objeto que representa o status de armazenamento warm em um ambiente.

Nome Tipo Description
propertiesUsage.state

WarmStoragePropertiesState

Essa cadeia de caracteres representa o estado do uso de propriedades de armazenamento warm. Pode ser "Ok", "Erro", "Desconhecido".

propertiesUsage.stateDetails.currentCount

integer

Um valor que representa o número de propriedades usadas pelo ambiente para SKU S1/S2 e o número de propriedades usadas pelo Warm Store para SKU PAYG

propertiesUsage.stateDetails.maxCount

integer

Um valor que representa o número máximo de propriedades usadas pelo ambiente para SKU S1/S2 e o número máximo de propriedades permitidas pelo Warm Store para SKU PAYG.

WarmStoragePropertiesState

Essa cadeia de caracteres representa o estado do uso de propriedades de armazenamento warm. Pode ser "Ok", "Erro", "Desconhecido".

Nome Tipo Description
Error

string

Ok

string

Unknown

string

WarmStoreConfigurationProperties

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.

Nome Tipo Description
dataRetention

string

ISO8601 período de tempo especificando o número de dias em que os eventos do ambiente estarão disponíveis para consulta no repositório quente.