你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

New-AzConnectedMachineRunCommand

用于创建运行命令的操作。

语法

New-AzConnectedMachineRunCommand
   -MachineName <String>
   -ResourceGroupName <String>
   -RunCommandName <String>
   [-SubscriptionId <String>]
   -Location <String>
   [-AsyncExecution]
   [-ErrorBlobManagedIdentityClientId <String>]
   [-ErrorBlobManagedIdentityObjectId <String>]
   [-ErrorBlobUri <String>]
   [-OutputBlobManagedIdentityClientId <String>]
   [-OutputBlobManagedIdentityObjectId <String>]
   [-OutputBlobUri <String>]
   [-Parameter <IRunCommandInputParameter[]>]
   [-ProtectedParameter <IRunCommandInputParameter[]>]
   [-RunAsPassword <String>]
   [-RunAsUser <String>]
   [-ScriptUriManagedIdentityClientId <String>]
   [-ScriptUriManagedIdentityObjectId <String>]
   [-SourceCommandId <String>]
   [-SourceScript <String>]
   [-SourceScriptUri <String>]
   [-Tag <Hashtable>]
   [-TimeoutInSecond <Int32>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzConnectedMachineRunCommand
   -MachineName <String>
   -ResourceGroupName <String>
   -RunCommandName <String>
   [-SubscriptionId <String>]
   -JsonString <String>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzConnectedMachineRunCommand
   -MachineName <String>
   -ResourceGroupName <String>
   -RunCommandName <String>
   [-SubscriptionId <String>]
   -JsonFilePath <String>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzConnectedMachineRunCommand
   -MachineName <String>
   -ResourceGroupName <String>
   -RunCommandName <String>
   [-SubscriptionId <String>]
   -RunCommandProperty <IMachineRunCommand>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzConnectedMachineRunCommand
   -RunCommandName <String>
   -MachineInputObject <IConnectedMachineIdentity>
   -Location <String>
   [-AsyncExecution]
   [-ErrorBlobManagedIdentityClientId <String>]
   [-ErrorBlobManagedIdentityObjectId <String>]
   [-ErrorBlobUri <String>]
   [-OutputBlobManagedIdentityClientId <String>]
   [-OutputBlobManagedIdentityObjectId <String>]
   [-OutputBlobUri <String>]
   [-Parameter <IRunCommandInputParameter[]>]
   [-ProtectedParameter <IRunCommandInputParameter[]>]
   [-RunAsPassword <String>]
   [-RunAsUser <String>]
   [-ScriptUriManagedIdentityClientId <String>]
   [-ScriptUriManagedIdentityObjectId <String>]
   [-SourceCommandId <String>]
   [-SourceScript <String>]
   [-SourceScriptUri <String>]
   [-Tag <Hashtable>]
   [-TimeoutInSecond <Int32>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzConnectedMachineRunCommand
   -RunCommandName <String>
   -MachineInputObject <IConnectedMachineIdentity>
   -RunCommandProperty <IMachineRunCommand>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzConnectedMachineRunCommand
   -InputObject <IConnectedMachineIdentity>
   -Location <String>
   [-AsyncExecution]
   [-ErrorBlobManagedIdentityClientId <String>]
   [-ErrorBlobManagedIdentityObjectId <String>]
   [-ErrorBlobUri <String>]
   [-OutputBlobManagedIdentityClientId <String>]
   [-OutputBlobManagedIdentityObjectId <String>]
   [-OutputBlobUri <String>]
   [-Parameter <IRunCommandInputParameter[]>]
   [-ProtectedParameter <IRunCommandInputParameter[]>]
   [-RunAsPassword <String>]
   [-RunAsUser <String>]
   [-ScriptUriManagedIdentityClientId <String>]
   [-ScriptUriManagedIdentityObjectId <String>]
   [-SourceCommandId <String>]
   [-SourceScript <String>]
   [-SourceScriptUri <String>]
   [-Tag <Hashtable>]
   [-TimeoutInSecond <Int32>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzConnectedMachineRunCommand
   -InputObject <IConnectedMachineIdentity>
   -RunCommandProperty <IMachineRunCommand>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

说明

用于创建运行命令的操作。

示例

示例 1:创建运行命令

New-AzConnectedMachineRunCommand -ResourceGroupName "ytongtest" -Location "eastus" -SourceScript "Write-Host Hello World!" -RunCommandName "myRunCommand2" -MachineName "testmachine" -Subscription "********-****-****-****-**********"

AsyncExecution                    : False
ErrorBlobManagedIdentityClientId  :
ErrorBlobManagedIdentityObjectId  :
ErrorBlobUri                      :
Id                                : /subscriptions/********-****-****-****-**********/resourceGroups/ytong
                                    test/providers/Microsoft.HybridCompute/machines/testmachine/runcommands/
                                    myRunCommand
InstanceViewEndTime               : 11/8/2024 7:43:31 PM
InstanceViewError                 :
InstanceViewExecutionMessage      : RunCommand script execution completed
InstanceViewExecutionState        : Succeeded
InstanceViewExitCode              : 0
InstanceViewOutput                : Hello World!
InstanceViewStartTime             : 11/8/2024 7:43:31 PM
InstanceViewStatuses              :
Location                          : eastus
Name                              : myRunCommand
OutputBlobManagedIdentityClientId :
OutputBlobManagedIdentityObjectId :
OutputBlobUri                     :
Parameter                         :
ProtectedParameter                :
ProvisioningState                 : Succeeded
ResourceGroupName                 : ytongtest
RunAsPassword                     :
RunAsUser                         :
ScriptUriManagedIdentityClientId  :
ScriptUriManagedIdentityObjectId  :
SourceCommandId                   :
SourceScript                      : Write-Host Hello World!
SourceScriptUri                   :
SystemDataCreatedAt               :
SystemDataCreatedBy               :
SystemDataCreatedByType           :
SystemDataLastModifiedAt          :
SystemDataLastModifiedBy          :
SystemDataLastModifiedByType      :
Tags                              : {
                                    }
TimeoutInSecond                   : 0
Type                              : Microsoft.HybridCompute/machines/runcommands

创建运行命令

参数

-AsJob

以作业身份运行命令

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-AsyncExecution

自选。 如果设置为 true,则脚本启动后预配将立即完成,并且不会等待脚本完成。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Confirm

在运行 cmdlet 之前,提示你进行确认。

类型:SwitchParameter
别名:cf
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-DefaultProfile

DefaultProfile 参数不起作用。 如果对其他订阅执行 cmdlet,请使用 SubscriptionId 参数。

类型:PSObject
别名:AzureRMContext, AzureCredential
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ErrorBlobManagedIdentityClientId

用户分配的托管标识的客户端 ID (GUID 值)。 如果未提供,则不应使用 ObjectId。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ErrorBlobManagedIdentityObjectId

用户分配的托管标识的对象 ID (GUID 值)。 如果未提供,则不应使用 ClientId。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ErrorBlobUri

指定将上传脚本错误流的 Azure 存储 Blob。 使用具有读取、追加、创建、写入访问权限的 SAS URI 或使用托管标识提供对 Blob 的 VM 访问权限。 引用 errorBlobManagedIdentity 参数。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-InputObject

标识参数

类型:IConnectedMachineIdentity
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-JsonFilePath

提供给“创建”操作的 Json 文件的路径

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-JsonString

提供给“创建”操作的 Json 字符串

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-Location

资源所在的地理位置

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-MachineInputObject

标识参数

类型:IConnectedMachineIdentity
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-MachineName

混合计算机的名称。

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-NoWait

异步运行命令

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-OutputBlobManagedIdentityClientId

用户分配的托管标识的客户端 ID (GUID 值)。 如果未提供,则不应使用 ObjectId。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-OutputBlobManagedIdentityObjectId

用户分配的托管标识的对象 ID (GUID 值)。 如果未提供,则不应使用 ClientId。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-OutputBlobUri

指定将上传脚本输出流的 Azure 存储 Blob。 使用具有读取、追加、创建、写入访问权限的 SAS URI 或使用托管标识提供对 Blob 的 VM 访问权限。 引用 outputBlobManagedIdentity 参数。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Parameter

脚本使用的参数。

类型:IRunCommandInputParameter[]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ProtectedParameter

脚本使用的参数。

类型:IRunCommandInputParameter[]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ResourceGroupName

资源组的名称。 名称不区分大小写。

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-RunAsPassword

在执行 run 命令时,指定计算机上的用户帐户密码。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-RunAsUser

在执行 run 命令时,指定计算机上的用户帐户。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-RunCommandName

run 命令的名称。

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-RunCommandProperty

描述运行命令

类型:IMachineRunCommand
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-ScriptUriManagedIdentityClientId

用户分配的托管标识的客户端 ID (GUID 值)。 如果未提供,则不应使用 ObjectId。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ScriptUriManagedIdentityObjectId

用户分配的托管标识的对象 ID (GUID 值)。 如果未提供,则不应使用 ClientId。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-SourceCommandId

指定预定义内置脚本的 commandId。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-SourceScript

指定要在计算机上执行的脚本内容。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-SourceScriptUri

指定脚本下载位置。 它可以是具有读取访问权限或公共 URI 的 Azure 存储 Blob 的 SAS URI。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-SubscriptionId

目标订阅的 ID。

类型:String
别名:Subscription
Position:Named
默认值:(Get-AzContext).Subscription.Id
必需:False
接受管道输入:False
接受通配符:False

-Tag

资源标记。

类型:Hashtable
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-TimeoutInSecond

执行 run 命令的超时(以秒为单位)。

类型:Int32
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 cmdlet 未运行。

类型:SwitchParameter
别名:wi
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

输入

IConnectedMachineIdentity

IMachineRunCommand

输出

IMachineRunCommand