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 os ambientes existentes para soluções alternativas o mais rápido possível. Para obter mais informações sobre a substituição e migração, visite nossa documentação.

Atenção

Este é um artigo 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 Description
Ambiente Um ambiente do Azure Time Series Insights é um agrupamento lógico de eventos que são lidos de corretores 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 eventos é uma conexão com um agente de eventos a partir do qual o Azure Time Series Insights lê e ingere eventos no ambiente. Atualmente, as fontes de eventos suportadas são o Hub IoT e o 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 associados 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 de 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 perspetivas 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 seguintes documentos descrevem os arquivos de modelo com mais detalhes:

O modelo de início rápido timeseriesinsights-environment-with-eventhub é publicado no GitHub. Este modelo cria um ambiente do Azure Time Series Insights, uma fonte de eventos 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 utilize o módulo Azure Az do PowerShell para interagir com o Azure. Para começar, consulte Instalar o Azure PowerShell. Para saber como migrar para o módulo do Az PowerShell, veja Migrar o Azure PowerShell do AzureRM para o Az.

Especificar modelo e parâmetros de implantação

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

  1. Instale o Azure PowerShell seguindo as instruções em Introdução ao Azure PowerShell.

  2. 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 arquivo timeseriesinsights-environment-with-eventhub .

      {
        "$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 Obrigatórios

      Parâmetro Description
      eventHubNamespaceName O namespace do hub de eventos de origem.
      eventHubName O nome do hub de eventos de origem.
      consumidorGrupoNome O nome do grupo de consumidores que o serviço Azure Time Series Insights usará para ler os dados do hub de eventos. NOTA: Para evitar a contenção de recursos, este grupo de consumidores tem de ser dedicado ao serviço Azure Time Series Insights e não partilhado com outros leitores.
      nome_do_ambiente O nome do ambiente. O nome não pode incluir: <, >, %, &, :, \\, ?, e /quaisquer caracteres de controle. Todos os outros carateres são permitidos.
      eventSourceName O nome do recurso filho da fonte do evento. O nome não pode incluir: <, >, %, &, :, \\, ?, e /quaisquer caracteres de controle. Todos os outros carateres são permitidos.
    • Parâmetros Opcionais

      Parâmetro Description
      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 fonte do evento. Observação : o usuário que implanta 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.
      environmentDisplayName Um nome amigável opcional para mostrar em ferramentas ou interfaces de usuário em vez do nome do ambiente.
      ambienteSkuName O nome de SKU. Para obter mais informações, leia a página Preços do Azure Time Series Insights.
      ambienteSkuCapacidade A capacidade da unidade do Sku. Para obter mais informações, leia a página Preços do Azure Time Series Insights.
      environmentDataRetentionTime O período de tempo mínimo 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 ferramentas ou interfaces de usuário em vez do nome da fonte do evento.
      eventSourceTimestampPropertyName A propriedade do evento que será usada como carimbo de data/hora da fonte do evento. Se um valor não for especificado para timestampPropertyName, ou se null ou empty-string for especificado, o tempo de criação do evento será usado.
      eventSourceKeyName O nome da chave de acesso compartilhada que o serviço Azure Time Series Insights usará para se conectar ao hub de eventos.
      accessPolicyReaderObjectIds Uma lista de IDs de objeto dos usuários ou aplicativos no Microsoft Entra ID que devem ter acesso de leitor ao ambiente. O objectId da entidade de serviço pode ser obtido chamando os cmdlets Get-AzADUser ou Get-AzADServicePrincipal . A criação de uma política de acesso para grupos do Microsoft Entra ainda não é suportada.
      accessPolicyContributorObjectIds Uma lista de IDs de objeto dos usuários ou aplicativos no Microsoft Entra ID que devem ter acesso de Colaborador ao ambiente. O objectId da entidade de serviço pode ser obtido chamando os cmdlets Get-AzADUser ou Get-AzADServicePrincipal . A criação de uma política de acesso para grupos do Microsoft Entra ainda não é suportada.
    • Como exemplo, o seguinte arquivo de parâmetros seria usado para criar um ambiente e uma fonte de eventos 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.

  1. No PowerShell, inicie sessão na 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 iniciar sessão, execute o seguinte comando para ver as subscrições disponíveis:

      Get-AzSubscription
      
    • Este comando devolve uma lista de subscrições do Azure disponíveis. Escolha uma assinatura para a sessão atual executando o seguinte comando. Substitua <YourSubscriptionId> pelo GUID da assinatura do Azure que você deseja usar:

      Set-AzContext -SubscriptionID <YourSubscriptionId>
      
  2. Crie um novo grupo de recursos, se 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 for bem-sucedido, será exibido um resumo do novo grupo de recursos.

      ResourceGroupName : MyDemoRG
      Location          : westus
      ProvisioningState : Succeeded
      Tags              :
      ResourceId        : /subscriptions/<GUID>/resourceGroups/MyDemoRG
      
  3. Teste a implantação.

    • Valide sua implantação executando o Test-AzResourceGroupDeployment cmdlet. 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
      
  4. Criar a implantação

    • Para criar a nova implantação, execute o New-AzResourceGroupDeployment cmdlet e forneça os parâmetros necessários quando solicitado. Os parâmetros incluem um nome para sua implantação, o nome do seu grupo de recursos e o caminho ou URL para o arquivo de modelo. Se o parâmetro Mode nã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 completa , defina o parâmetro Mode como Complete:

      New-AzResourceGroupDeployment -Name MyDemoDeployment -Mode Complete -ResourceGroupName MyDemoRG -TemplateFile <path to template file>\azuredeploy.json
      
  5. Verificar a implementaçã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 :
      
  6. Implantar o modelo de início rápido por meio do portal do Azure

    • A home page do modelo de início rápido 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 a partir dos parâmetros necessários ou tabelas de parâmetros opcionais. Depois de preencher as configurações, clicar no botão Comprar iniciará a implantação do modelo.

Botão Implantar no Azure

Próximos passos