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=2018-08-15-preview

Parâmetros de URI

Name In Required Type 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:

Name Description
LongTermEnvironmentCreateOrUpdateParameters

Parâmetros fornecidos para a operação criar ou atualizar ambiente para um ambiente de longo prazo.

StandardEnvironmentCreateOrUpdateParameters

Parâmetros fornecidos para a operação criar ou atualizar ambiente para um ambiente padrão.

LongTermEnvironmentCreateOrUpdateParameters

Parâmetros fornecidos para a operação criar ou atualizar ambiente para um ambiente de longo prazo.

Name Required Type Description
kind True string:
  • LongTerm

O tipo do ambiente.

location True
  • string

A localização do recurso.

properties.storageConfiguration True

A configuração de armazenamento fornece os detalhes de conexão que permitem que o serviço de Time Series Insights se conecte à conta de armazenamento do cliente que é usada para armazenar os dados do ambiente.

properties.timeSeriesIdProperties True

A lista de propriedades do evento que será usada para definir a ID da série temporal do ambiente.

sku True

A SKU determina o tipo de ambiente, Standard (S1 ou S2) ou de longo prazo (L1). Para ambientes padrão, a SKU determina a capacidade do ambiente, a taxa de entrada e a taxa de cobrança.

properties.warmStoreConfiguration

A configuração de armazenamento quente fornece os detalhes para criar um cache de armazenamento quente que manterá uma cópia dos dados do ambiente disponíveis para uma consulta mais rápida.

tags
  • object

Pares de chave-valor de propriedades adicionais para o recurso.

StandardEnvironmentCreateOrUpdateParameters

Parâmetros fornecidos para a operação criar ou atualizar ambiente para um ambiente padrão.

Name Required Type Description
kind True string:
  • Standard

O tipo do ambiente.

location True
  • string

A localização do recurso.

properties.dataRetentionTime True
  • string

ISO8601 TimeSpan especificando o número mínimo de dias pelos quais os eventos do ambiente estarão disponíveis para consulta.

sku True

A SKU determina o tipo de ambiente, Standard (S1 ou S2) ou de longo prazo (L1). Para ambientes padrão, a SKU determina a capacidade do ambiente, a taxa de entrada e a taxa de cobrança.

properties.partitionKeyProperties

A lista de propriedades de evento que será usada para particionar dados no ambiente. Atualmente, há suporte apenas para uma única propriedade de chave de partição.

properties.storageLimitExceededBehavior

O comportamento que o serviço de Time Series Insights deve executar 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 de chave-valor de propriedades adicionais para o recurso.

Respostas

Name Type 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

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

Segurança

azure_auth

Azure Active Directory fluxo OAuth2

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

Scopes

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

Definições

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 Time Series Insights serviço.

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"

LongTermEnvironmentCreateOrUpdateParameters

Parâmetros fornecidos para a operação criar ou atualizar ambiente para um ambiente de longo prazo.

LongTermEnvironmentResource

Um ambiente é um conjunto de dados de séries temporárias disponíveis para consulta e é o recurso de Azure Time Series Insights superior. Ambientes LongTerm não têm limites de retenção de dados definidos.

LongTermStorageConfigurationInput

A configuração de armazenamento fornece os detalhes de conexão que permitem que o serviço de Time Series Insights se conecte à conta de armazenamento do cliente que é usada para armazenar os dados do ambiente.

LongTermStorageConfigurationOutput

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

PropertyType

O tipo da propriedade.

ProvisioningState

Estado de provisionamento do recurso.

Sku

A SKU determina o tipo de ambiente, Standard (S1 ou S2) ou de longo prazo (L1). Para ambientes padrão, a SKU determina a capacidade do ambiente, a taxa de entrada e a taxa de cobrança.

SkuName

O nome desta SKU.

StandardEnvironmentCreateOrUpdateParameters

Parâmetros fornecidos para a operação criar ou atualizar ambiente para um ambiente padrão.

StandardEnvironmentResource

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

StorageLimitExceededBehavior

O comportamento que o serviço de Time Series Insights deve executar 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 propriedades desse tipo.

WarmStorageEnvironmentStatus

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

WarmStoragePropertiesState

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

WarmStoreConfigurationProperties

A configuração de armazenamento quente fornece os detalhes para criar um cache de armazenamento 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.

Name Type Description
error

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.

Name Type Description
code
  • string

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

details

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.

Name Type 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 Time Series Insights serviço.

Name Type Description
ingress

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

warmStorage

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

IngressEnvironmentStatus

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

Name Type Description
state

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

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"

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

LongTermEnvironmentCreateOrUpdateParameters

Parâmetros fornecidos para a operação criar ou atualizar ambiente para um ambiente de longo prazo.

Name Type Description
kind string:
  • LongTerm

O tipo do ambiente.

location
  • string

A localização do recurso.

properties.storageConfiguration

A configuração de armazenamento fornece os detalhes de conexão que permitem que o serviço de Time Series Insights se conecte à conta de armazenamento do cliente que é usada para armazenar os dados do ambiente.

properties.timeSeriesIdProperties

A lista de propriedades do evento que será usada para definir a ID da série temporal do ambiente.

properties.warmStoreConfiguration

A configuração de armazenamento quente fornece os detalhes para criar um cache de armazenamento quente que manterá uma cópia dos dados do ambiente disponíveis para uma consulta mais rápida.

sku

A SKU determina o tipo de ambiente, Standard (S1 ou S2) ou de longo prazo (L1). Para ambientes padrão, a SKU determina a capacidade do ambiente, a taxa de entrada e a taxa de cobrança.

tags
  • object

Pares de chave-valor de propriedades adicionais para o recurso.

LongTermEnvironmentResource

Um ambiente é um conjunto de dados de séries temporárias disponíveis para consulta e é o recurso de Azure Time Series Insights superior. Ambientes LongTerm não têm limites de retenção de dados definidos.

Name Type Description
creationTime
  • string

A hora em que o recurso foi criado.

id
  • string

ID do recurso

kind string:
  • LongTerm

O tipo do ambiente.

location
  • string

Localização do recurso

name
  • string

Nome do recurso

properties.creationTime
  • string

A hora em que o recurso foi criado.

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

Estado de provisionamento do recurso.

properties.status

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

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

properties.timeSeriesIdProperties

A lista de propriedades de evento que serão usadas para definir a ID de séries temportivas do ambiente.

properties.warmStoreConfiguration

A configuração de armazenamento warm fornece os detalhes para criar um cache de armazenamento quente que manterá uma cópia dos dados do ambiente disponíveis para uma consulta mais rápida.

provisioningState

Estado de provisionamento do recurso.

sku

O sku determina o tipo de ambiente, padrão (S1 ou S2) ou de longo prazo (L1). Para ambientes padrão, 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

LongTermStorageConfigurationInput

A configuração de armazenamento fornece os detalhes de conexão que permitem que o serviço de Time Series Insights se conecte à conta de armazenamento do cliente que é usada para armazenar os dados do ambiente.

Name Type Description
accountName
  • string

O nome da conta de armazenamento que irá manter os dados de longo prazo do ambiente.

managementKey
  • string

O valor da chave de gerenciamento que concede ao serviço de Time Series Insights acesso de gravação à conta de armazenamento. Essa propriedade não é mostrada em respostas de ambiente.

LongTermStorageConfigurationOutput

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

Name Type Description
accountName
  • string

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

PropertyType

O tipo da propriedade.

Name Type Description
String
  • string

ProvisioningState

Estado de provisionamento do recurso.

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

Sku

A SKU determina o tipo de ambiente, Standard (S1 ou S2) ou de longo prazo (L1). Para ambientes padrão, a SKU determina a capacidade do ambiente, a taxa de entrada e a taxa de cobrança.

Name Type Description
capacity
  • integer

A capacidade da SKU. Para ambientes padrão, esse valor pode ser alterado para dar suporte à expansão de ambientes depois que eles tiverem sido criados.

name

O nome desta SKU.

SkuName

O nome desta SKU.

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

StandardEnvironmentCreateOrUpdateParameters

Parâmetros fornecidos para a operação criar ou atualizar ambiente para um ambiente padrão.

Name Type Description
kind string:
  • Standard

O tipo do ambiente.

location
  • string

A localização do recurso.

properties.dataRetentionTime
  • string

ISO8601 TimeSpan especificando o número mínimo de dias pelos quais os eventos do ambiente estarão disponíveis para consulta.

properties.partitionKeyProperties

A lista de propriedades de evento que será usada para particionar dados no ambiente. Atualmente, há suporte apenas para uma única propriedade de chave de partição.

properties.storageLimitExceededBehavior

O comportamento que o serviço de Time Series Insights deve executar 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

A SKU determina o tipo de ambiente, Standard (S1 ou S2) ou de longo prazo (L1). Para ambientes padrão, a SKU determina a capacidade do ambiente, a taxa de entrada e a taxa de cobrança.

tags
  • object

Pares de chave-valor de propriedades adicionais para o recurso.

StandardEnvironmentResource

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

Name Type Description
creationTime
  • string

A hora em que o recurso foi criado.

id
  • string

ID do recurso

kind string:
  • Standard

O tipo do ambiente.

location
  • string

Localização do recurso

name
  • string

Nome do recurso

properties.creationTime
  • string

A hora em que o recurso foi criado.

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 TimeSpan especificando o número mínimo de dias pelos quais os eventos do ambiente estarão disponíveis para consulta.

properties.partitionKeyProperties

A lista de propriedades de evento que será usada para particionar dados no ambiente. Atualmente, há suporte apenas para uma única propriedade de chave de partição.

properties.provisioningState

Estado de provisionamento do recurso.

properties.status

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

properties.storageLimitExceededBehavior

O comportamento que o serviço de Time Series Insights deve executar 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

Estado de provisionamento do recurso.

sku

A SKU determina o tipo de ambiente, Standard (S1 ou S2) ou de longo prazo (L1). Para ambientes padrão, a 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

StorageLimitExceededBehavior

O comportamento que o serviço de Time Series Insights deve executar 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.

Name Type 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 propriedades desse tipo.

Name Type Description
name
  • string

O nome da propriedade.

type

O tipo da propriedade.

WarmStorageEnvironmentStatus

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

Name Type Description
propertiesUsage.state

Essa cadeia de caracteres representa o estado de 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 de uso de propriedades de armazenamento warm. Pode ser "Ok", "Erro", "Desconhecido".

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

WarmStoreConfigurationProperties

A configuração de armazenamento quente fornece os detalhes para criar um cache de armazenamento quente que manterá uma cópia dos dados do ambiente disponíveis para uma consulta mais rápida.

Name Type Description
dataRetention
  • string

ISO8601 TimeSpan especificando o número de dias pelos quais os eventos do ambiente estarão disponíveis para consulta na loja quente.