Criar recursos do Azure Time Series Insights Gen 1 usando modelos do Azure Resource Manager
Nota
O serviço Time Series Insights será desativado em 7 de julho de 2024. Considere migrar ambientes existentes para soluções alternativas o mais rápido possível. Para obter mais informações sobre a substituição e a migração, visite nossa documentação .
Cuidado
Este é um artigo do Gen1.
Este artigo descreve como criar e implantar recursos do Azure Time Series Insights usando modelos do Azure Resource Manager, PowerShell e o provedor de recursos do Azure Time Series Insights.
O Azure Time Series Insights dá suporte aos seguintes recursos:
Recurso | Descrição |
---|---|
Ambiente | Um ambiente do Azure Time Series Insights é um agrupamento lógico de eventos que são lidos de agentes de eventos, armazenados e disponibilizados para consulta. Para obter mais informações, leia Planejar seu ambiente do Azure Time Series Insights |
Origem do evento | Uma fonte de evento é uma conexão com um corretor de eventos do qual o Azure Time Series Insights lê e incorpora eventos ao ambiente. As fontes de eventos com suporte no momento são Hub IoT e Hub de Eventos. |
Conjunto de Dados de Referência | Os conjuntos de dados de referência fornecem metadados sobre os eventos no ambiente. Os metadados nos conjuntos de dados de referência serão unidos a eventos durante a entrada. Os conjuntos de dados de referência são definidos como recursos por suas propriedades de chave de evento. Os metadados reais que compõem o conjunto de dados de referência são carregados ou modificados por meio de APIs do plano de dados. |
Política de Acesso | As políticas de acesso concedem permissões para emitir consultas de dados, manipular dados de referência no ambiente e compartilhar consultas salvas e perspectivas associadas ao ambiente. Para obter mais informações, leia Conceder acesso a dados a um ambiente do Azure Time Series Insights usando o portal do Azure |
Um modelo do Resource Manager é um arquivo JSON que define a infraestrutura e a configuração de recursos em um grupo de recursos. Os documentos a seguir descrevem os arquivos de modelo com mais detalhes:
- Implantação de modelo do Azure Resource Manager
- Implantar recursos com modelos do Resource Manager e com Azure PowerShell
- tipos de recurso Microsoft.TimeSeriesInsights
O modelo de início rápido timeseriesinsights-environment-with-eventhub é publicado no GitHub. Esse modelo cria um ambiente do Azure Time Series Insights, uma fonte de evento filho configurada para consumir eventos de um Hub de Eventos e políticas de acesso que concedem acesso aos dados do ambiente. Se um Hub de Eventos existente não for especificado, um será criado com a implantação.
Nota
Recomendamos que você use o módulo do Az PowerShell do Azure para interagir com o Azure. Para começar, consulte Instalar o Azure PowerShell. Para saber como migrar para o módulo do Az PowerShell, consulte Migrar o Azure PowerShell do AzureRM para o Az.
Especificar o modelo de implantação e os parâmetros
O procedimento a seguir descreve como usar o PowerShell para implantar um modelo do Azure Resource Manager que cria um ambiente do Azure Time Series Insights, uma fonte de evento filho configurada para consumir eventos de um Hub de Eventos e políticas de acesso que concedem acesso aos dados do ambiente. Se um Hub de Eventos existente não for especificado, um será criado com a implantação.
Instale o Azure PowerShell seguindo as instruções em Introdução ao Azure PowerShell.
Clone ou copie o modelo timeseriesinsights-environment-with-eventhub do GitHub.
Criar um arquivo de parâmetros
Para criar um arquivo de parâmetros, copie o timeseriesinsights-environment-with-eventhub arquivo.
{ "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#", "contentVersion": "1.0.0.0", "parameters": { "eventHubNamespaceName": { "value": "GEN-UNIQUE" }, "eventHubName": { "value": "GEN-UNIQUE" }, "consumerGroupName": { "value": "GEN-UNIQUE" }, "environmentName": { "value": "GEN-UNIQUE" }, "eventSourceName": { "value": "GEN-UNIQUE" } } }
Parâmetros necessários
Parâmetro Descrição eventHubNamespaceName O namespace do hub de eventos de origem. eventHubName O nome do hub de origem do evento. NomeDoGrupoDeConsumidores O nome do grupo de consumidores que o serviço do Azure Time Series Insights usará para ler os dados do hub de eventos. OBSERVAÇÃO: Para evitar a contenção de recursos, esse grupo de consumidores deve ser dedicado ao serviço do Azure Time Series Insights e não compartilhado com outros leitores. nomeDoAmbiente O nome do ambiente. O nome não pode incluir: <
,>
,%
,&
,:
,\\
,?
,/
e quaisquer caracteres de controle. Todos os outros caracteres são permitidos.nomeFonteEvento O nome do filho do recurso de origem do evento. O nome não pode incluir: <
,>
,%
,&
,:
,\\
,?
,/
e quaisquer caracteres de controle. Todos os outros caracteres são permitidos.
Parâmetros opcionais
Parâmetro Descrição existingEventHubResourceId Uma ID de recurso opcional de um Hub de Eventos existente que será conectado ao ambiente do Azure Time Series Insights por meio da origem do evento. OBSERVAÇÃO: O usuário que está implantando o modelo deve ter privilégios para executar a operação listkeys no Hub de Eventos. Se nenhum valor for passado, um novo hub de eventos será criado pelo modelo. NomeExibidoDoAmbiente Um nome amigável opcional a ser mostrado em interfaces de usuário ou ferramentas em vez do nome do ambiente. environmentSkuName O nome do SKU. Para obter mais informações, leia a página de preços do Azure Time Series Insights . environmentSkuCapacity A capacidade da unidade do Sku. Para obter mais informações, leia a página de preços do Azure Time Series Insights. tempoDeRetençãoDeDadosDoAmbiente O período mínimo de tempo em que os eventos do ambiente estarão disponíveis para consulta. O valor deve ser especificado no formato ISO 8601, por exemplo, P30D
para uma política de retenção de 30 dias.eventSourceDisplayName Um nome amigável opcional para mostrar em interfaces de usuário ou ferramentas em vez do nome de origem do evento. nomeDaPropriedadeTimestampDaFonteDoEvento A propriedade de evento que será usada como carimbo de data/hora da fonte do evento. Se um valor não for especificado para timestampPropertyName ou se nulo ou cadeia de caracteres vazia for especificado, a hora de criação do evento será usada. eventSourceKeyName O nome da chave de acesso compartilhado que o serviço do Azure Time Series Insights usará para se conectar ao hub de eventos. IdsObjetoLeitorPolíticaDeAcesso Uma lista de IDs de objeto dos usuários ou aplicativos no Microsoft Entra ID que devem ter acesso de leitura ao ambiente. O objectId do serviço principal pode ser obtido chamando o cmdlet Get-AzADUser ou o cmdlet Get-AzADServicePrincipal. Ainda não há suporte para a criação de uma política de acesso para grupos do Microsoft Entra. IDs de Objeto do Contribuidor de Política de Acesso Uma lista de IDs de objeto dos usuários ou aplicativos no Microsoft Entra ID que devem receber acesso de Colaborador ao ambiente. O objectId do principal do serviço pode ser obtido chamando o cmdlet Get-AzADUser ou pelo cmdlet Get-AzADServicePrincipal . Ainda não há suporte para a criação de uma política de acesso para grupos do Microsoft Entra.Por exemplo, o arquivo de parâmetros a seguir seria usado para criar um ambiente e uma fonte de evento que lê eventos de um hub de eventos existente. Ele também cria duas políticas de acesso que concedem ao Colaborador acesso ao ambiente.
{ "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#", "contentVersion": "1.0.0.0", "parameters": { "eventHubNamespaceName": { "value": "tsiTemplateTestNamespace" }, "eventHubName": { "value": "tsiTemplateTestEventHub" }, "consumerGroupName": { "value": "tsiTemplateTestConsumerGroup" }, "environmentName": { "value": "tsiTemplateTestEnvironment" }, "eventSourceName": { "value": "tsiTemplateTestEventSource" }, "existingEventHubResourceId": { "value": "/subscriptions/{yourSubscription}/resourceGroups/MyDemoRG/providers/Microsoft.EventHub/namespaces/tsiTemplateTestNamespace/eventhubs/tsiTemplateTestEventHub" }, "accessPolicyContributorObjectIds": { "value": [ "AGUID001-0000-0000-0000-000000000000", "AGUID002-0000-0000-0000-000000000000" ] } } }
Para obter mais informações, leia o artigo parâmetros.
Implantar o modelo de início rápido localmente usando o PowerShell
Importante
As operações de linha de comando exibidas abaixo descrevem o módulo Az PowerShell.
No PowerShell, faça logon em sua conta do Azure.
Em um prompt do PowerShell, execute o seguinte comando:
Connect-AzAccount
Você será solicitado a fazer logon em sua conta do Azure. Depois de fazer logon, execute o seguinte comando para exibir suas assinaturas disponíveis:
Get-AzSubscription
Esse comando retorna uma lista de assinaturas disponíveis do Azure. Escolha uma assinatura para a sessão atual executando o comando a seguir. Substitua
<YourSubscriptionId>
pelo GUID para a assinatura do Azure que você deseja usar:Set-AzContext -SubscriptionID <YourSubscriptionId>
Crie um novo grupo de recursos se um não existir.
Se você não tiver um grupo de recursos existente, crie um novo grupo de recursos com o comando New-AzResourceGroup. Forneça o nome do grupo de recursos e o local que você deseja usar. Por exemplo:
New-AzResourceGroup -Name MyDemoRG -Location "West US"
Se bem-sucedido, um resumo do novo grupo de recursos será exibido.
ResourceGroupName : MyDemoRG Location : westus ProvisioningState : Succeeded Tags : ResourceId : /subscriptions/<GUID>/resourceGroups/MyDemoRG
Teste a implantação.
Valide sua implantação executando o cmdlet
Test-AzResourceGroupDeployment
. Ao testar a implantação, forneça parâmetros exatamente como faria ao executar a implantação.Test-AzResourceGroupDeployment -ResourceGroupName MyDemoRG -TemplateFile <path to template file>\azuredeploy.json -TemplateParameterFile <path to parameters file>\azuredeploy.parameters.json
Criar a implantação
Para criar a nova implantação, execute o cmdlet
New-AzResourceGroupDeployment
e forneça os parâmetros necessários quando solicitado. Os parâmetros incluem um nome para sua implantação, o nome do grupo de recursos e o caminho ou URL para o arquivo de modelo. Se o parâmetro do Modonão for especificado, o valor padrão de incremental será usado. Para obter mais informações, leia implantações incrementais e completas. O comando a seguir solicita os cinco parâmetros necessários na janela do PowerShell:
New-AzResourceGroupDeployment -Name MyDemoDeployment -ResourceGroupName MyDemoRG -TemplateFile <path to template file>\azuredeploy.json
Para especificar um arquivo de parâmetros, use o seguinte comando:
New-AzResourceGroupDeployment -Name MyDemoDeployment -ResourceGroupName MyDemoRG -TemplateFile <path to template file>\azuredeploy.json -TemplateParameterFile <path to parameters file>\azuredeploy.parameters.json
Você também pode usar parâmetros embutidos ao executar o cmdlet de implantação. O comando é o seguinte:
New-AzResourceGroupDeployment -Name MyDemoDeployment -ResourceGroupName MyDemoRG -TemplateFile <path to template file>\azuredeploy.json -parameterName "parameterValue"
Para executar uma implantação de
completa, defina o parâmetro do Modo como Concluir :New-AzResourceGroupDeployment -Name MyDemoDeployment -Mode Complete -ResourceGroupName MyDemoRG -TemplateFile <path to template file>\azuredeploy.json
Verificar a implantação
Se os recursos forem implantados com êxito, um resumo da implantação será exibido na janela do PowerShell:
DeploymentName : MyDemoDeployment ResourceGroupName : MyDemoRG ProvisioningState : Succeeded Timestamp : 10/11/2019 3:20:37 AM Mode : Incremental TemplateLink : Parameters : Name Type Value ================================== ========================= ========== eventHubNewOrExisting String new eventHubResourceGroup String MyDemoRG eventHubNamespaceName String tsiquickstartns eventHubName String tsiquickstarteh consumerGroupName String tsiquickstart environmentName String tsiquickstart environmentDisplayName String tsiquickstart environmentSkuName String S1 environmentSkuCapacity Int 1 environmentDataRetentionTime String P30D eventSourceName String tsiquickstart eventSourceDisplayName String tsiquickstart eventSourceTimestampPropertyName String eventSourceKeyName String manage accessPolicyReaderObjectIds Array [] accessPolicyContributorObjectIds Array [] location String westus Outputs : Name Type Value ================ ========================= ========== dataAccessFQDN String 11aa1aa1-a1aa-1a1a-a11a-aa111a111a11.env.timeseries.azure.com DeploymentDebugLogLevel :
Implantar o modelo de início rápido por meio do portal do Azure
- A página inicial do modelo Quickstart no GitHub também inclui um botão Implantar no Azure. Clicar nele abre uma página de Implantação Personalizada no portal do Azure. Nesta página, você pode inserir ou selecionar valores para cada um dos parâmetros nas tabelas de parâmetros necessários ou opcionais. Depois de preencher as configurações, clicar no botão Comprar iniciará a implantação do modelo.