了解如何使用执行基本流分析任务的 Azure PowerShell cmdlet 和 PowerShell 脚本监视和管理流分析资源。
注释
建议使用 Azure Az PowerShell 模块与 Azure 交互。 请参阅安装 Azure PowerShell 以开始使用。 若要了解如何迁移到 Az PowerShell 模块,请参阅 将 Azure PowerShell 从 AzureRM 迁移到 Az。
运行流分析的 Azure PowerShell cmdlet 的先决条件
- 在订阅中创建 Azure 资源组。 下面是一个示例 Azure PowerShell 脚本。 有关 Azure PowerShell 信息,请参阅 安装和配置 Azure PowerShell;
Azure PowerShell 0.9.8:
# Log in to your Azure account
Add-AzureAccount -Environment AzureChinaCloud
# 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 -Environment AzureChinaCloud
# 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>
注释
默认情况下,以编程方式创建的流分析作业未启用监视。 可以在 Azure 门户中通过导航到作业的“监视”页面并点击“启用”按钮手动启用监视,或者可以按照 Azure 流分析 - 以编程方式监视流分析作业中的步骤以编程方式进行操作。
用于流分析的 Azure PowerShell 命令
以下 Azure PowerShell cmdlet 可用于监视和管理 Azure 流分析作业。 请注意,Azure PowerShell 具有不同的版本。 在列出的示例中,第一个命令适用于 Azure PowerShell 0.9.8,第二个命令适用于 Azure PowerShell 1.0。 Azure PowerShell 1.0 命令将始终在命令中具有“Az”。
Get-AzureStreamAnalyticsJob |Get-AzStreamAnalyticsJob
列出在 Azure 订阅或指定资源组中定义的所有流分析作业,或获取有关资源组中特定作业的作业信息。
示例 1
Azure PowerShell 0.9.8:
Get-AzureStreamAnalyticsJob
Azure PowerShell 1.0:
Get-AzStreamAnalyticsJob
此 PowerShell 命令返回有关 Azure 订阅中所有流分析作业的信息。
示例 2
Azure PowerShell 0.9.8:
Get-AzureStreamAnalyticsJob -ResourceGroupName StreamAnalytics-Default-East-CN
Azure PowerShell 1.0:
Get-AzStreamAnalyticsJob -ResourceGroupName StreamAnalytics-Default-East-CN
此 PowerShell 命令返回有关资源组 StreamAnalytics-Default-East-CN 中所有流分析作业的信息。
示例 3
Azure PowerShell 0.9.8:
Get-AzureStreamAnalyticsJob -ResourceGroupName StreamAnalytics-Default-East-CN -Name StreamingJob
Azure PowerShell 1.0:
Get-AzStreamAnalyticsJob -ResourceGroupName StreamAnalytics-Default-East-CN -Name StreamingJob
此 PowerShell 命令返回有关资源组 StreamAnalytics-Default-East-CN 中的流分析作业 StreamingJob 的信息。
Get-AzureStreamAnalyticsInput | Get-AzStreamAnalyticsInput
列出指定流分析作业中定义的所有输入,或获取有关特定输入的信息。
示例 1
Azure PowerShell 0.9.8:
Get-AzureStreamAnalyticsInput -ResourceGroupName StreamAnalytics-Default-East-CN -JobName StreamingJob
Azure PowerShell 1.0:
Get-AzStreamAnalyticsInput -ResourceGroupName StreamAnalytics-Default-East-CN -JobName StreamingJob
此 PowerShell 命令返回有关作业 StreamingJob 中定义的所有输入的信息。
示例 2
Azure PowerShell 0.9.8:
Get-AzureStreamAnalyticsInput -ResourceGroupName StreamAnalytics-Default-East-CN -JobName StreamingJob -Name EntryStream
Azure PowerShell 1.0:
Get-AzStreamAnalyticsInput -ResourceGroupName StreamAnalytics-Default-East-CN -JobName StreamingJob -Name EntryStream
此 PowerShell 命令返回有关作业 StreamingJob 中定义的名为 EntryStream 的输入的信息。
Get-AzureStreamAnalyticsOutput | Get-AzStreamAnalyticsOutput (用于获取Azure流分析输出的命令)
列出指定流分析作业中定义的所有输出,或获取有关特定输出的信息。
示例 1
Azure PowerShell 0.9.8:
Get-AzureStreamAnalyticsOutput -ResourceGroupName StreamAnalytics-Default-East-CN -JobName StreamingJob
Azure PowerShell 1.0:
Get-AzStreamAnalyticsOutput -ResourceGroupName StreamAnalytics-Default-East-CN -JobName StreamingJob
此 PowerShell 命令返回有关作业 StreamingJob 中定义的输出的信息。
示例 2
Azure PowerShell 0.9.8:
Get-AzureStreamAnalyticsOutput -ResourceGroupName StreamAnalytics-Default-East-CN -JobName StreamingJob -Name Output
Azure PowerShell 1.0:
Get-AzStreamAnalyticsOutput -ResourceGroupName StreamAnalytics-Default-East-CN -JobName StreamingJob -Name Output
此 PowerShell 命令返回有关作业 StreamingJob 中定义的名为 Output 的输出的信息。
Get-AzureStreamAnalyticsQuota |Get-AzStreamAnalyticsQuota
获取有关指定区域中流单元配额的信息。
示例 1
Azure PowerShell 0.9.8:
Get-AzureStreamAnalyticsQuota -Location "China East"
Azure PowerShell 1.0:
Get-AzStreamAnalyticsQuota -Location "China East"
此 PowerShell 命令返回有关中国东部区域中流单元的配额和使用情况的信息。
Get-AzureStreamAnalyticsTransformation | Get-AzStreamAnalyticsTransformation
获取有关在流分析作业中定义的特定转换的信息。
示例 1
Azure PowerShell 0.9.8:
Get-AzureStreamAnalyticsTransformation -ResourceGroupName StreamAnalytics-Default-East-CN -JobName StreamingJob -Name StreamingJob
Azure PowerShell 1.0:
Get-AzStreamAnalyticsTransformation -ResourceGroupName StreamAnalytics-Default-East-CN -JobName StreamingJob -Name StreamingJob
此 PowerShell 命令返回有关作业 StreamingJob 中名为 StreamingJob 的转换的信息。
New-AzureStreamAnalyticsInput | New-AzStreamAnalyticsInput
在流分析作业中创建新输入,或更新现有的指定输入。
可以在 .json 文件或命令行中指定输入的名称。 如果同时指定了两者,则命令行上的名称必须与文件中的名称相同。
如果指定已存在且未指定 -Force 参数的输入,cmdlet 将询问是否替换现有输入。
如果指定 -Force 参数并指定现有输入名称,则无需确认即可替换输入。
有关 JSON 文件结构和内容的详细信息,请参阅流分析管理 REST API 参考库的“创建输入”(Azure 流分析)部分。
示例 1
Azure PowerShell 0.9.8:
New-AzureStreamAnalyticsInput -ResourceGroupName StreamAnalytics-Default-East-CN -JobName StreamingJob -File "C:\Input.json"
Azure PowerShell 1.0:
New-AzStreamAnalyticsInput -ResourceGroupName StreamAnalytics-Default-East-CN -JobName StreamingJob -File "C:\Input.json"
此 PowerShell 命令从文件 Input.json创建新的输入。 如果在输入定义文件中指定名称的输入已经存在,那么 cmdlet 将询问是否要替换该输入。
示例 2
Azure PowerShell 0.9.8:
New-AzureStreamAnalyticsInput -ResourceGroupName StreamAnalytics-Default-East-CN -JobName StreamingJob -File "C:\Input.json" -Name EntryStream
Azure PowerShell 1.0:
New-AzStreamAnalyticsInput -ResourceGroupName StreamAnalytics-Default-East-CN -JobName StreamingJob -File "C:\Input.json" -Name EntryStream
此 PowerShell 命令在名为 EntryStream 的作业中创建一个新输入。 如果已定义具有此名称的现有输入,cmdlet 将询问是否替换它。
示例 3
Azure PowerShell 0.9.8:
New-AzureStreamAnalyticsInput -ResourceGroupName StreamAnalytics-Default-East-CN -JobName StreamingJob -File "C:\Input.json" -Name EntryStream -Force
Azure PowerShell 1.0:
New-AzStreamAnalyticsInput -ResourceGroupName StreamAnalytics-Default-East-CN -JobName StreamingJob -File "C:\Input.json" -Name EntryStream -Force
此 PowerShell 命令将名为 EntryStream 的现有输入源的定义替换为文件中的定义。
New-AzureStreamAnalyticsJob | New-AzStreamAnalyticsJob
在 Azure 中创建新的流分析作业,或更新现有指定作业的定义。
可以在 .json 文件或命令行中指定作业的名称。 如果同时指定了两者,则命令行上的名称必须与文件中的名称相同。
如果指定已存在的作业名称且未指定 -Force 参数,cmdlet 将询问是否替换现有作业。
如果指定 -Force 参数并指定现有作业名称,则无需确认即可替换作业定义。
有关 JSON 文件结构和内容的详细信息,请参阅流分析管理 REST API 参考库的“创建流分析作业”部分。
示例 1
Azure PowerShell 0.9.8:
New-AzureStreamAnalyticsJob -ResourceGroupName StreamAnalytics-Default-East-CN -File "C:\JobDefinition.json"
Azure PowerShell 1.0:
New-AzStreamAnalyticsJob -ResourceGroupName StreamAnalytics-Default-East-CN -File "C:\JobDefinition.json"
此 PowerShell 命令从 JobDefinition.json中的定义创建新作业。 如果已有指定名称的现有作业定义在作业定义文件中,cmdlet 会询问是否替换它。
示例 2
Azure PowerShell 0.9.8:
New-AzureStreamAnalyticsJob -ResourceGroupName StreamAnalytics-Default-East-CN -File "C:\JobDefinition.json" -Name StreamingJob -Force
Azure PowerShell 1.0:
New-AzStreamAnalyticsJob -ResourceGroupName StreamAnalytics-Default-East-CN -File "C:\JobDefinition.json" -Name StreamingJob -Force
此 PowerShell 命令替换 StreamingJob 的作业定义。
New-AzureStreamAnalyticsOutput | New-AzStreamAnalyticsOutput(用于管理 Azure 流分析的输出配置命令)
在流分析作业中创建新输出,或更新现有输出。
可以在 .json 文件或命令行中指定输出的名称。 如果同时指定了两者,则命令行上的名称必须与文件中的名称相同。
如果指定已经存在且未指定 -Force 参数的输出,cmdlet 将询问是否替换现有输出。
如果指定 -Force 参数并指定现有输出名称,则会在不确认的情况下替换输出。
有关 JSON 文件结构和内容的详细信息,请参阅流分析管理 REST API 参考库的“创建输出”(Azure 流分析)部分。
示例 1
Azure PowerShell 0.9.8:
New-AzureStreamAnalyticsOutput -ResourceGroupName StreamAnalytics-Default-East-CN -File "C:\Output.json" -JobName StreamingJob -Name output
Azure PowerShell 1.0:
New-AzStreamAnalyticsOutput -ResourceGroupName StreamAnalytics-Default-East-CN -File "C:\Output.json" -JobName StreamingJob -Name output
此 PowerShell 命令在作业 StreamingJob 中创建名为“output”的新输出。 如果已定义具有此名称的现有输出,cmdlet 将询问是否替换它。
示例 2
Azure PowerShell 0.9.8:
New-AzureStreamAnalyticsOutput -ResourceGroupName StreamAnalytics-Default-East-CN -File "C:\Output.json" -JobName StreamingJob -Name output -Force
Azure PowerShell 1.0:
New-AzStreamAnalyticsOutput -ResourceGroupName StreamAnalytics-Default-East-CN -File "C:\Output.json" -JobName StreamingJob -Name output -Force
此 PowerShell 命令替换作业 StreamingJob 中“输出”的定义。
New-AzureStreamAnalyticsTransformation |New-AzStreamAnalyticsTransformation
在流分析作业中创建新转换,或更新现有转换。
可以在 .json 文件或命令行中指定转换的名称。 如果同时指定了两者,则命令行上的名称必须与文件中的名称相同。
如果指定已存在的转换且未指定 -Force 参数,cmdlet 将询问是否替换现有转换。
如果指定 -Force 参数并指定现有转换名称,则转换将替换而不进行确认。
有关 JSON 文件结构和内容的详细信息,请参阅流分析管理 REST API 参考库的“创建转换”(Azure 流分析)部分。
示例 1
Azure PowerShell 0.9.8:
New-AzureStreamAnalyticsTransformation -ResourceGroupName StreamAnalytics-Default-East-CN -File "C:\Transformation.json" -JobName StreamingJob -Name StreamingJobTransform
Azure PowerShell 1.0:
New-AzStreamAnalyticsTransformation -ResourceGroupName StreamAnalytics-Default-East-CN -File "C:\Transformation.json" -JobName StreamingJob -Name StreamingJobTransform
此 PowerShell 命令在作业 StreamingJob 中创建名为 StreamingJobTransform 的新转换。 如果已使用此名称定义现有转换,cmdlet 将询问是否替换它。
示例 2
Azure PowerShell 0.9.8:
New-AzureStreamAnalyticsTransformation -ResourceGroupName StreamAnalytics-Default-East-CN -File "C:\Transformation.json" -JobName StreamingJob -Name StreamingJobTransform -Force
Azure PowerShell 1.0:
New-AzStreamAnalyticsTransformation -ResourceGroupName StreamAnalytics-Default-East-CN -File "C:\Transformation.json" -JobName StreamingJob -Name StreamingJobTransform -Force
此 PowerShell 命令替换作业 StreamingJob 中的 StreamingJobTransform 定义。
Remove-AzureStreamAnalyticsInput |Remove-AzStreamAnalyticsInput
从 Azure 中的流分析作业异步删除特定输入。
如果指定 -Force 参数,则无需确认即可删除输入。
示例 1
Azure PowerShell 0.9.8:
Remove-AzureStreamAnalyticsInput -ResourceGroupName StreamAnalytics-Default-East-CN -JobName StreamingJob -Name EventStream
Azure PowerShell 1.0:
Remove-AzStreamAnalyticsInput -ResourceGroupName StreamAnalytics-Default-East-CN -JobName StreamingJob -Name EventStream
此 PowerShell 命令删除作业 StreamingJob 中的输入 EventStream。
Remove-AzureStreamAnalyticsJob |Remove-AzStreamAnalyticsJob
异步删除 Azure 中的特定流分析作业。
如果指定 -Force 参数,则会在不确认的情况下删除作业。
示例 1
Azure PowerShell 0.9.8:
Remove-AzureStreamAnalyticsJob -ResourceGroupName StreamAnalytics-Default-East-CN -Name StreamingJob
Azure PowerShell 1.0:
Remove-AzStreamAnalyticsJob -ResourceGroupName StreamAnalytics-Default-East-CN -Name StreamingJob
此 PowerShell 命令删除作业 StreamingJob。
Remove-AzureStreamAnalyticsOutput |Remove-AzStreamAnalyticsOutput
异步删除 Azure 中流分析作业的特定输出。
如果指定 -Force 参数,则输出将被删除,无需确认。
示例 1
Azure PowerShell 0.9.8:
Remove-AzureStreamAnalyticsOutput -ResourceGroupName StreamAnalytics-Default-East-CN -JobName StreamingJob -Name Output
Azure PowerShell 1.0:
Remove-AzStreamAnalyticsOutput -ResourceGroupName StreamAnalytics-Default-East-CN -JobName StreamingJob -Name Output
此 PowerShell 命令删除作业 StreamingJob 中的输出输出。
Start-AzureStreamAnalyticsJob | Start-AzStreamAnalyticsJob
在 Azure 中异步部署和启动流分析作业。
示例 1
Azure PowerShell 0.9.8:
Start-AzureStreamAnalyticsJob -ResourceGroupName StreamAnalytics-Default-East-CN -Name StreamingJob -OutputStartMode CustomTime -OutputStartTime 2012-12-12T12:12:12Z
Azure PowerShell 1.0:
Start-AzStreamAnalyticsJob -ResourceGroupName StreamAnalytics-Default-East-CN -Name StreamingJob -OutputStartMode CustomTime -OutputStartTime 2012-12-12T12:12:12Z
此 PowerShell 命令启动作业 StreamingJob,其自定义输出开始时间设置为 2012 年 12 月 12 日 12:12:12 UTC。
停止 Azure Stream Analytics 作业 (Stop-AzureStreamAnalyticsJob) | 停止 Azure Stream Analytics 作业 (Stop-AzStreamAnalyticsJob)
异步停止在 Azure 中运行的流分析作业,并释放正在使用的资源。 作业定义和元数据将通过 Azure 门户和管理 API 在订阅中保持可用,以便可以编辑和重启作业。 对于处于停止状态的作业,不收取费用。
示例 1
Azure PowerShell 0.9.8:
Stop-AzureStreamAnalyticsJob -ResourceGroupName StreamAnalytics-Default-East-CN -Name StreamingJob
Azure PowerShell 1.0:
Stop-AzStreamAnalyticsJob -ResourceGroupName StreamAnalytics-Default-East-CN -Name StreamingJob
此 PowerShell 命令停止作业 StreamingJob。
Test-AzureStreamAnalyticsInput |Test-AzStreamAnalyticsInput
测试 Stream Analytics 连接指定输入的能力。
示例 1
Azure PowerShell 0.9.8:
Test-AzureStreamAnalyticsInput -ResourceGroupName StreamAnalytics-Default-East-CN -JobName StreamingJob -Name EntryStream
Azure PowerShell 1.0:
Test-AzStreamAnalyticsInput -ResourceGroupName StreamAnalytics-Default-East-CN -JobName StreamingJob -Name EntryStream
此 PowerShell 命令测试 StreamingJob 中输入 EntryStream 的连接状态。
Test-AzureStreamAnalyticsOutput |Test-AzStreamAnalyticsOutput
测试流分析连接到指定输出的能力。
示例 1
Azure PowerShell 0.9.8:
Test-AzureStreamAnalyticsOutput -ResourceGroupName StreamAnalytics-Default-East-CN -JobName StreamingJob -Name Output
Azure PowerShell 1.0:
Test-AzStreamAnalyticsOutput -ResourceGroupName StreamAnalytics-Default-East-CN -JobName StreamingJob -Name Output
此 PowerShell 命令测试 StreamingJob 中输出输出的连接状态。
获取支持
如需获取进一步的帮助,可前往 Azure 流分析的 Microsoft 问答页面。