Monitorar e gerenciar trabalhos do Stream Analytics com cmdlets do Azure PowerShell
Saiba como monitorar e gerenciar recursos do Stream Analytics com cmdlets do Azure PowerShell e scripts do PowerShell que executam tarefas básicas do Stream Analytics.
Nota
Recomendamos que utilize o módulo do Azure Az PowerShell para interagir com o Azure. Veja Instalar o Azure PowerShell para começar. Para saber como migrar para o módulo do Az PowerShell, veja Migrar o Azure PowerShell do AzureRM para o Az.
Pré-requisitos para executar cmdlets do Azure PowerShell para o Stream Analytics
- Crie um Grupo de Recursos do Azure na sua subscrição. A seguir está um exemplo de script do Azure PowerShell. Para obter informações sobre o Azure PowerShell, consulte Instalar e configurar o Azure PowerShell;
Azure PowerShell 0.9.8:
# Log in to your Azure account
Add-AzureAccount
# Select the Azure subscription you want to use to create the resource group if you have more han one subscription on your account.
Select-AzureSubscription -SubscriptionName <subscription name>
# If Stream Analytics has not been registered to the subscription, remove remark symbol below (#)to run the Register-AzureProvider cmdlet to register the provider namespace.
#Register-AzureProvider -Force -ProviderNamespace 'Microsoft.StreamAnalytics'
# Create an Azure resource group
New-AzureResourceGroup -Name <YOUR RESOURCE GROUP NAME> -Location <LOCATION>
Azure PowerShell 1.0:
# Log in to your Azure account
Connect-AzAccount
# Select the Azure subscription you want to use to create the resource group.
Get-AzSubscription -SubscriptionName "your sub" | Select-AzSubscription
# If Stream Analytics has not been registered to the subscription, remove remark symbol below (#)to run the Register-AzureProvider cmdlet to register the provider namespace.
#Register-AzResourceProvider -Force -ProviderNamespace 'Microsoft.StreamAnalytics'
# Create an Azure resource group
New-AzResourceGroup -Name <YOUR RESOURCE GROUP NAME> -Location <LOCATION>
Nota
Os trabalhos do Stream Analytics criados programaticamente não têm o monitoramento habilitado por padrão. Você pode habilitar manualmente o monitoramento no Portal do Azure navegando até a página Monitor do trabalho e clicando no botão Habilitar ou pode fazer isso programaticamente seguindo as etapas localizadas em Azure Stream Analytics - Monitorar trabalhos do Stream Analytics programaticamente.
Cmdlets do Azure PowerShell para Stream Analytics
Os seguintes cmdlets do Azure PowerShell podem ser usados para monitorar e gerenciar trabalhos do Azure Stream Analytics. Observe que o Azure PowerShell tem versões diferentes. Nos exemplos listados, o primeiro comando é para o Azure PowerShell 0.9.8, o segundo comando é para o Azure PowerShell 1.0. Os comandos do Azure PowerShell 1.0 sempre terão "Az" no comando.
Get-AzureStreamAnalyticsJob | Get-AzStreamAnalyticsJob
Lista todos os trabalhos do Stream Analytics definidos na assinatura do Azure ou no grupo de recursos especificado ou obtém informações de trabalho sobre um trabalho específico dentro de um grupo de recursos.
Exemplo 1
Azure PowerShell 0.9.8:
Get-AzureStreamAnalyticsJob
Azure PowerShell 1.0:
Get-AzStreamAnalyticsJob
Este comando do PowerShell retorna informações sobre todos os trabalhos do Stream Analytics na assinatura do Azure.
Exemplo 2
Azure PowerShell 0.9.8:
Get-AzureStreamAnalyticsJob -ResourceGroupName StreamAnalytics-Default-Central-US
Azure PowerShell 1.0:
Get-AzStreamAnalyticsJob -ResourceGroupName StreamAnalytics-Default-Central-US
Este comando do PowerShell retorna informações sobre todos os trabalhos do Stream Analytics no grupo de recursos StreamAnalytics-Default-Central-US.
Exemplo 3
Azure PowerShell 0.9.8:
Get-AzureStreamAnalyticsJob -ResourceGroupName StreamAnalytics-Default-Central-US -Name StreamingJob
Azure PowerShell 1.0:
Get-AzStreamAnalyticsJob -ResourceGroupName StreamAnalytics-Default-Central-US -Name StreamingJob
Este comando do PowerShell retorna informações sobre o trabalho do Stream Analytics StreamingJob no grupo de recursos StreamAnalytics-Default-Central-US.
Get-AzureStreamAnalyticsInput | Get-AzStreamAnalyticsInput
Lista todas as entradas definidas em um trabalho especificado do Stream Analytics ou obtém informações sobre uma entrada específica.
Exemplo 1
Azure PowerShell 0.9.8:
Get-AzureStreamAnalyticsInput -ResourceGroupName StreamAnalytics-Default-Central-US -JobName StreamingJob
Azure PowerShell 1.0:
Get-AzStreamAnalyticsInput -ResourceGroupName StreamAnalytics-Default-Central-US -JobName StreamingJob
Este comando do PowerShell retorna informações sobre todas as entradas definidas no trabalho StreamingJob.
Exemplo 2
Azure PowerShell 0.9.8:
Get-AzureStreamAnalyticsInput -ResourceGroupName StreamAnalytics-Default-Central-US -JobName StreamingJob -Name EntryStream
Azure PowerShell 1.0:
Get-AzStreamAnalyticsInput -ResourceGroupName StreamAnalytics-Default-Central-US -JobName StreamingJob -Name EntryStream
Este comando do PowerShell retorna informações sobre a entrada chamada EntryStream definida no trabalho StreamingJob.
Get-AzureStreamAnalyticsOutput | Get-AzStreamAnalyticsOutput
Lista todas as saídas definidas em um trabalho especificado do Stream Analytics ou obtém informações sobre uma saída específica.
Exemplo 1
Azure PowerShell 0.9.8:
Get-AzureStreamAnalyticsOutput -ResourceGroupName StreamAnalytics-Default-Central-US -JobName StreamingJob
Azure PowerShell 1.0:
Get-AzStreamAnalyticsOutput -ResourceGroupName StreamAnalytics-Default-Central-US -JobName StreamingJob
Este comando do PowerShell retorna informações sobre as saídas definidas no trabalho StreamingJob.
Exemplo 2
Azure PowerShell 0.9.8:
Get-AzureStreamAnalyticsOutput -ResourceGroupName StreamAnalytics-Default-Central-US -JobName StreamingJob -Name Output
Azure PowerShell 1.0:
Get-AzStreamAnalyticsOutput -ResourceGroupName StreamAnalytics-Default-Central-US -JobName StreamingJob -Name Output
Este comando do PowerShell retorna informações sobre a saída chamada Output definida no trabalho StreamingJob.
Get-AzureStreamAnalyticsQuota | Get-AzStreamAnalyticsQuota
Obtém informações sobre a cota de unidades de streaming em uma região especificada.
Exemplo 1
Azure PowerShell 0.9.8:
Get-AzureStreamAnalyticsQuota -Location "Central US"
Azure PowerShell 1.0:
Get-AzStreamAnalyticsQuota -Location "Central US"
Este comando do PowerShell retorna informações sobre a cota e o uso de unidades de streaming na região dos EUA Central.
Get-AzureStreamAnalyticsTransformation | Get-AzStreamAnalyticsTransformação
Obtém informações sobre uma transformação específica definida em um trabalho do Stream Analytics.
Exemplo 1
Azure PowerShell 0.9.8:
Get-AzureStreamAnalyticsTransformation -ResourceGroupName StreamAnalytics-Default-Central-US -JobName StreamingJob -Name StreamingJob
Azure PowerShell 1.0:
Get-AzStreamAnalyticsTransformation -ResourceGroupName StreamAnalytics-Default-Central-US -JobName StreamingJob -Name StreamingJob
Este comando do PowerShell retorna informações sobre a transformação chamada StreamingJob no trabalho StreamingJob.
New-AzureStreamAnalyticsInput | New-AzStreamAnalyticsInput
Cria uma nova entrada dentro de um trabalho do Stream Analytics ou atualiza uma entrada especificada existente.
O nome da entrada pode ser especificado no arquivo .json ou na linha de comando. Se ambos forem especificados, o nome na linha de comando deve ser o mesmo que o do arquivo.
Se você especificar uma entrada que já existe e não especificar o parâmetro -Force, o cmdlet perguntará se a entrada existente deve ou não ser substituída.
Se você especificar o parâmetro -Force e especificar um nome de entrada existente, a entrada será substituída sem confirmação.
Para obter informações detalhadas sobre a estrutura e o conteúdo do arquivo JSON, consulte a seção Criar entrada (Azure Stream Analytics) da Biblioteca de Referência da API REST do Stream Analytics Management.
Exemplo 1
Azure PowerShell 0.9.8:
New-AzureStreamAnalyticsInput -ResourceGroupName StreamAnalytics-Default-Central-US -JobName StreamingJob -File "C:\Input.json"
Azure PowerShell 1.0:
New-AzStreamAnalyticsInput -ResourceGroupName StreamAnalytics-Default-Central-US -JobName StreamingJob -File "C:\Input.json"
Este comando do PowerShell cria uma nova entrada a partir do arquivo Input.json. Se uma entrada existente com o nome especificado no arquivo de definição de entrada já estiver definida, o cmdlet perguntará se deve ou não substituí-la.
Exemplo 2
Azure PowerShell 0.9.8:
New-AzureStreamAnalyticsInput -ResourceGroupName StreamAnalytics-Default-Central-US -JobName StreamingJob -File "C:\Input.json" -Name EntryStream
Azure PowerShell 1.0:
New-AzStreamAnalyticsInput -ResourceGroupName StreamAnalytics-Default-Central-US -JobName StreamingJob -File "C:\Input.json" -Name EntryStream
Este comando do PowerShell cria uma nova entrada no trabalho chamada EntryStream. Se uma entrada existente com esse nome já estiver definida, o cmdlet perguntará se ela deve ou não ser substituída.
Exemplo 3
Azure PowerShell 0.9.8:
New-AzureStreamAnalyticsInput -ResourceGroupName StreamAnalytics-Default-Central-US -JobName StreamingJob -File "C:\Input.json" -Name EntryStream -Force
Azure PowerShell 1.0:
New-AzStreamAnalyticsInput -ResourceGroupName StreamAnalytics-Default-Central-US -JobName StreamingJob -File "C:\Input.json" -Name EntryStream -Force
Este comando do PowerShell substitui a definição da fonte de entrada existente chamada EntryStream pela definição do arquivo.
New-AzureStreamAnalyticsJob | Novo-AzStreamAnalyticsJob
Cria um novo trabalho do Stream Analytics no Microsoft Azure ou atualiza a definição de um trabalho especificado existente.
O nome do trabalho pode ser especificado no arquivo .json ou na linha de comando. Se ambos forem especificados, o nome na linha de comando deve ser o mesmo que o do arquivo.
Se você especificar um nome de trabalho que já existe e não especificar o parâmetro -Force, o cmdlet perguntará se o trabalho deve ou não ser substituído.
Se você especificar o parâmetro -Force e especificar um nome de trabalho existente, a definição de trabalho será substituída sem confirmação.
Para obter informações detalhadas sobre a estrutura e o conteúdo do arquivo JSON, consulte a seção Criar trabalho do Stream Analytics da Biblioteca de referência da API REST do Stream Analytics Management.
Exemplo 1
Azure PowerShell 0.9.8:
New-AzureStreamAnalyticsJob -ResourceGroupName StreamAnalytics-Default-Central-US -File "C:\JobDefinition.json"
Azure PowerShell 1.0:
New-AzStreamAnalyticsJob -ResourceGroupName StreamAnalytics-Default-Central-US -File "C:\JobDefinition.json"
Este comando do PowerShell cria um novo trabalho a partir da definição em JobDefinition.json. Se um trabalho existente com o nome especificado no arquivo de definição de trabalho já estiver definido, o cmdlet perguntará se deve ou não substituí-lo.
Exemplo 2
Azure PowerShell 0.9.8:
New-AzureStreamAnalyticsJob -ResourceGroupName StreamAnalytics-Default-Central-US -File "C:\JobDefinition.json" -Name StreamingJob -Force
Azure PowerShell 1.0:
New-AzStreamAnalyticsJob -ResourceGroupName StreamAnalytics-Default-Central-US -File "C:\JobDefinition.json" -Name StreamingJob -Force
Este comando do PowerShell substitui a definição de tarefa para StreamingJob.
New-AzureStreamAnalyticsOutput | New-AzStreamAnalyticsOutput
Cria uma nova saída dentro de um trabalho do Stream Analytics ou atualiza uma saída existente.
O nome da saída pode ser especificado no arquivo .json ou na linha de comando. Se ambos forem especificados, o nome na linha de comando deve ser o mesmo que o do arquivo.
Se você especificar uma saída que já existe e não especificar o parâmetro -Force, o cmdlet perguntará se a saída existente deve ou não ser substituída.
Se você especificar o parâmetro -Force e especificar um nome de saída existente, a saída será substituída sem confirmação.
Para obter informações detalhadas sobre a estrutura e o conteúdo do arquivo JSON, consulte a seção Criar saída (Azure Stream Analytics) da Biblioteca de referência da API REST do Stream Analytics Management.
Exemplo 1
Azure PowerShell 0.9.8:
New-AzureStreamAnalyticsOutput -ResourceGroupName StreamAnalytics-Default-Central-US -File "C:\Output.json" -JobName StreamingJob -Name output
Azure PowerShell 1.0:
New-AzStreamAnalyticsOutput -ResourceGroupName StreamAnalytics-Default-Central-US -File "C:\Output.json" -JobName StreamingJob -Name output
Este comando do PowerShell cria uma nova saída chamada "output" no trabalho StreamingJob. Se uma saída existente com esse nome já estiver definida, o cmdlet perguntará se deve ou não substituí-la.
Exemplo 2
Azure PowerShell 0.9.8:
New-AzureStreamAnalyticsOutput -ResourceGroupName StreamAnalytics-Default-Central-US -File "C:\Output.json" -JobName StreamingJob -Name output -Force
Azure PowerShell 1.0:
New-AzStreamAnalyticsOutput -ResourceGroupName StreamAnalytics-Default-Central-US -File "C:\Output.json" -JobName StreamingJob -Name output -Force
Este comando do PowerShell substitui a definição de "saída" no trabalho StreamingJob.
New-AzureStreamAnalyticsTransformation | Novo-AzStreamAnalyticsTransformation
Cria uma nova transformação dentro de um trabalho do Stream Analytics ou atualiza a transformação existente.
O nome da transformação pode ser especificado no arquivo .json ou na linha de comando. Se ambos forem especificados, o nome na linha de comando deve ser o mesmo que o do arquivo.
Se você especificar uma transformação que já existe e não especificar o parâmetro -Force, o cmdlet perguntará se a transformação existente deve ou não ser substituída.
Se você especificar o parâmetro -Force e especificar um nome de transformação existente, a transformação será substituída sem confirmação.
Para obter informações detalhadas sobre a estrutura e o conteúdo do arquivo JSON, consulte a seção Criar transformação (Azure Stream Analytics) da Biblioteca de Referência da API REST do Stream Analytics Management.
Exemplo 1
Azure PowerShell 0.9.8:
New-AzureStreamAnalyticsTransformation -ResourceGroupName StreamAnalytics-Default-Central-US -File "C:\Transformation.json" -JobName StreamingJob -Name StreamingJobTransform
Azure PowerShell 1.0:
New-AzStreamAnalyticsTransformation -ResourceGroupName StreamAnalytics-Default-Central-US -File "C:\Transformation.json" -JobName StreamingJob -Name StreamingJobTransform
Este comando do PowerShell cria uma nova transformação chamada StreamingJobTransform no trabalho StreamingJob. Se uma transformação existente já estiver definida com esse nome, o cmdlet perguntará se ela deve ou não ser substituída.
Exemplo 2
Azure PowerShell 0.9.8:
New-AzureStreamAnalyticsTransformation -ResourceGroupName StreamAnalytics-Default-Central-US -File "C:\Transformation.json" -JobName StreamingJob -Name StreamingJobTransform -Force
Azure PowerShell 1.0:
New-AzStreamAnalyticsTransformation -ResourceGroupName StreamAnalytics-Default-Central-US -File "C:\Transformation.json" -JobName StreamingJob -Name StreamingJobTransform -Force
Este comando do PowerShell substitui a definição de StreamingJobTransform no trabalho StreamingJob.
Remove-AzureStreamAnalyticsInput | Remover-AzStreamAnalyticsInput
Exclui de forma assíncrona uma entrada específica de um trabalho do Stream Analytics no Microsoft Azure.
Se você especificar o parâmetro -Force, a entrada será excluída sem confirmação.
Exemplo 1
Azure PowerShell 0.9.8:
Remove-AzureStreamAnalyticsInput -ResourceGroupName StreamAnalytics-Default-Central-US -JobName StreamingJob -Name EventStream
Azure PowerShell 1.0:
Remove-AzStreamAnalyticsInput -ResourceGroupName StreamAnalytics-Default-Central-US -JobName StreamingJob -Name EventStream
Este comando do PowerShell remove a entrada EventStream no trabalho StreamingJob.
Remove-AzureStreamAnalyticsJob | Remove-AzStreamAnalyticsJob
Exclui de forma assíncrona um trabalho específico do Stream Analytics no Microsoft Azure.
Se você especificar o parâmetro -Force, o trabalho será excluído sem confirmação.
Exemplo 1
Azure PowerShell 0.9.8:
Remove-AzureStreamAnalyticsJob -ResourceGroupName StreamAnalytics-Default-Central-US -Name StreamingJob
Azure PowerShell 1.0:
Remove-AzStreamAnalyticsJob -ResourceGroupName StreamAnalytics-Default-Central-US -Name StreamingJob
Este comando do PowerShell remove o trabalho StreamingJob.
Remover-AzureStreamAnalyticsOutput | Remove-AzStreamAnalyticsOutput
Exclui de forma assíncrona uma saída específica de um trabalho do Stream Analytics no Microsoft Azure.
Se você especificar o parâmetro -Force, a saída será excluída sem confirmação.
Exemplo 1
Azure PowerShell 0.9.8:
Remove-AzureStreamAnalyticsOutput -ResourceGroupName StreamAnalytics-Default-Central-US -JobName StreamingJob -Name Output
Azure PowerShell 1.0:
Remove-AzStreamAnalyticsOutput -ResourceGroupName StreamAnalytics-Default-Central-US -JobName StreamingJob -Name Output
Este comando do PowerShell remove a saída Output no trabalho StreamingJob.
Start-AzureStreamAnalyticsJob | Start-AzStreamAnalyticsJob
Implanta e inicia de forma assíncrona um trabalho do Stream Analytics no Microsoft Azure.
Exemplo 1
Azure PowerShell 0.9.8:
Start-AzureStreamAnalyticsJob -ResourceGroupName StreamAnalytics-Default-Central-US -Name StreamingJob -OutputStartMode CustomTime -OutputStartTime 2012-12-12T12:12:12Z
Azure PowerShell 1.0:
Start-AzStreamAnalyticsJob -ResourceGroupName StreamAnalytics-Default-Central-US -Name StreamingJob -OutputStartMode CustomTime -OutputStartTime 2012-12-12T12:12:12Z
Este comando do PowerShell inicia o trabalho StreamingJob com uma hora de início de saída personalizada definida para 12 de dezembro de 2012, 12:12:12 UTC.
Stop-AzureStreamAnalyticsJob | Stop-AzStreamAnalyticsJob
Impede de forma assíncrona a execução de um trabalho do Stream Analytics no Microsoft Azure e desaloca recursos que estavam sendo usados. A definição de trabalho e os metadados permanecerão disponíveis em sua assinatura por meio do portal do Azure e das APIs de gerenciamento, de modo que o trabalho possa ser editado e reiniciado. Você não será cobrado por um trabalho no estado parado.
Exemplo 1
Azure PowerShell 0.9.8:
Stop-AzureStreamAnalyticsJob -ResourceGroupName StreamAnalytics-Default-Central-US -Name StreamingJob
Azure PowerShell 1.0:
Stop-AzStreamAnalyticsJob -ResourceGroupName StreamAnalytics-Default-Central-US -Name StreamingJob
Este comando do PowerShell interrompe o trabalho StreamingJob.
Test-AzureStreamAnalyticsInput | Test-AzStreamAnalyticsInput
Testa a capacidade do Stream Analytics de se conectar a uma entrada especificada.
Exemplo 1
Azure PowerShell 0.9.8:
Test-AzureStreamAnalyticsInput -ResourceGroupName StreamAnalytics-Default-Central-US -JobName StreamingJob -Name EntryStream
Azure PowerShell 1.0:
Test-AzStreamAnalyticsInput -ResourceGroupName StreamAnalytics-Default-Central-US -JobName StreamingJob -Name EntryStream
Este comando do PowerShell testa o status da conexão do EntryStream de entrada em StreamingJob.
Test-AzureStreamAnalyticsOutput | Test-AzStreamAnalyticsOutput
Testa a capacidade do Stream Analytics de se conectar a uma saída especificada.
Exemplo 1
Azure PowerShell 0.9.8:
Test-AzureStreamAnalyticsOutput -ResourceGroupName StreamAnalytics-Default-Central-US -JobName StreamingJob -Name Output
Azure PowerShell 1.0:
Test-AzStreamAnalyticsOutput -ResourceGroupName StreamAnalytics-Default-Central-US -JobName StreamingJob -Name Output
Este comando do PowerShell testa o status da conexão da saída Output em StreamingJob.
Obter suporte
Para obter mais assistência, experimente a nossa página de perguntas e respostas da Microsoft para o Azure Stream Analytics.