使用 Azure PowerShell cmdlet 监视和管理流分析作业
了解如何使用可执行基本流分析任务的 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 cmdlet
下面的 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
列出在指定流分析作业中定义的所有输出,或获取有关特定输出的信息。
示例 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
在流分析作业中创建新的输出,或者更新现有的输出。
输出的名称可以在 .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 中“output”的定义。
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 中的输出 Output。
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)。
Stop-AzureStreamAnalyticsJob | 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
测试流分析能否连接到指定的输入。
示例 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 中输出 Output 的连接状态。
获取支持
如需获取进一步的帮助,可前往 Azure 流分析的 Microsoft 问答页面。