New-AzStorageTaskAssignment

模块:

Az.Storage Module

使用指定的参数异步创建新的存储任务分配子资源。 如果已创建存储任务分配，并发出具有不同属性的后续创建请求，则会更新存储任务分配属性。 如果已创建存储任务分配，并且后续创建请求使用完全相同的属性集发出，则请求将成功。

语法

Default (默认值)

New-AzStorageTaskAssignment
    -AccountName <String>
    -Name <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String>]
    -Description <String>
    [-Enabled]
    -ReportPrefix <String>
    -TaskId <String>
    -TriggerType <String>
    [-EndBy <DateTime>]
    [-Interval <Int32>]
    [-IntervalUnit <String>]
    [-StartFrom <DateTime>]
    [-StartOn <DateTime>]
    [-TargetExcludePrefix <String[]>]
    [-TargetPrefix <String[]>]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

说明

使用指定的参数异步创建新的存储任务分配子资源。 如果已创建存储任务分配，并发出具有不同属性的后续创建请求，则会更新存储任务分配属性。 如果已创建存储任务分配，并且后续创建请求使用完全相同的属性集发出，则请求将成功。

示例

示例 1：创建运行一次的任务分配

$taskid = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.StorageActions/storageTasks/mytask"
New-AzStorageTaskAssignment -ResourceGroupName myresourcegroup -AccountName myaccount -name mytaskassignment -TaskId $taskid -ReportPrefix "test" -TriggerType RunOnce -StartOn (Get-Date).ToUniversalTime() -Description "task assignment" -Enabled:$false

Description                     : task assignment
Enabled                         : False
EndBy                           :
Id                              : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.Storage/storageAccounts/myaccount/storageTaskAssignments/mytaskassignment
Interval                        :
IntervalUnit                    :
Name                            : mytaskassignment
ProvisioningState               : Succeeded
ReportPrefix                    : test
ResourceGroupName               : myresourcegroup
RunStatusEnum                   :
RunStatusError                  :
RunStatusFinishTime             :
RunStatusObjectFailedCount      :
RunStatusObjectsOperatedOnCount :
RunStatusObjectsSucceededCount  :
RunStatusObjectsTargetedCount   :
RunStatusRunResult              :
RunStatusStartTime              :
RunStatusStorageAccountId       :
RunStatusSummaryReportPath      :
RunStatusTaskAssignmentId       :
RunStatusTaskId                 :
RunStatusTaskVersion            :
StartFrom                       :
StartOn                         : 7/2/2024 4:39:15 AM
TargetExcludePrefix             :
TargetPrefix                    :
TaskId                          : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.StorageActions/storageTasks/mytask
TriggerType                     : RunOnce
Type                            : Microsoft.Storage/storageAccounts/storageTaskAssignments

此命令创建一个运行一次的任务分配。

示例 2：创建按计划运行的任务分配

$start = Get-Date -Year 2024 -Month 8 -Day 7 -Hour 1 -Minute 30
$end = Get-Date -Year 2024 -Month 12 -Day 25 -Hour 2 -Minute 45
$taskid = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.StorageActions/storageTasks/mytask"
New-AzStorageTaskAssignment -accountname myaccount -name mytaskassignment -resourcegroupname myresourcegroup -TaskId $taskid -ReportPrefix test -StartFrom $start.ToUniversalTime() -TriggerType OnSchedule -Interval 10 -IntervalUnit Days -Description "my task assignment" -Enabled:$false -EndBy $end.ToUniversalTime()

Description                     : my task assignment
Enabled                         : False
EndBy                           : 12/24/2024 6:45:03 PM
Id                              : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.Storage/storageAccounts/myaccount/storageTaskAssignments/myassignment
Interval                        : 10
IntervalUnit                    : days
Name                            : mytaskassignment
ProvisioningState               : Succeeded
ReportPrefix                    : test
ResourceGroupName               : myresourcegroup
RunStatusEnum                   :
RunStatusError                  :
RunStatusFinishTime             :
RunStatusObjectFailedCount      :
RunStatusObjectsOperatedOnCount :
RunStatusObjectsSucceededCount  :
RunStatusObjectsTargetedCount   :
RunStatusRunResult              :
RunStatusStartTime              :
RunStatusStorageAccountId       :
RunStatusSummaryReportPath      :
RunStatusTaskAssignmentId       :
RunStatusTaskId                 :
RunStatusTaskVersion            :
StartFrom                       : 8/6/2024 5:30:39 PM
StartOn                         :
TargetExcludePrefix             :
TargetPrefix                    :
TaskId                          : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.StorageActions/storageTasks/
                                  mytask
TriggerType                     : OnSchedule
Type                            : Microsoft.Storage/storageAccounts/storageTaskAssignments

此命令创建一个任务分配，该任务分配每 10 天运行一次，从 2024 年 8 月 6 日 5：30：39 到 2024/12/24 下午 6：45：03。

参数

-AccountName

指定资源组中的存储帐户的名称。 存储帐户名称长度必须介于 3 到 24 个字符之间，并且仅使用数字和小写字母。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-AsJob

以作业身份运行命令

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Confirm

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

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False
别名:	Cf

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-DefaultProfile

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

参数属性

类型:	PSObject
默认值:	None
支持通配符:	False
不显示:	False
别名:	AzureRMContext, AzureCredential

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Description

描述存储任务分配用途的文本

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Enabled

是否启用存储任务分配

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-EndBy

何时结束任务执行。 当 ExecutionTrigger.properties.type 为“OnSchedule”时，这是必填字段;当 ExecutionTrigger.properties.type 为“RunOnce”时，此属性不应存在

参数属性

类型:	DateTime
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Interval

任务执行的运行间隔。 当 ExecutionTrigger.properties.type 为“OnSchedule”时，这是必填字段;当 ExecutionTrigger.properties.type 为“RunOnce”时，此属性不应存在

参数属性

类型:	Int32
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-IntervalUnit

运行任务执行的间隔单位。 当 ExecutionTrigger.properties.type 为“OnSchedule”时，这是必填字段;当 ExecutionTrigger.properties.type 为“RunOnce”时，此属性不应存在

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Name

指定资源组中存储任务分配的名称。 存储任务分配名称长度必须介于 3 到 24 个字符之间，并且仅使用数字和小写字母。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False
别名:	StorageTaskAssignmentName

参数集

(All)

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-NoWait

异步运行命令

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-ReportPrefix

存储任务分配报告位置的容器前缀

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-ResourceGroupName

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

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-StartFrom

何时启动任务执行。 当 ExecutionTrigger.properties.type 为“OnSchedule”时，这是必填字段;当 ExecutionTrigger.properties.type 为“RunOnce”时，此属性不应存在

参数属性

类型:	DateTime
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-StartOn

何时启动任务执行。 当 ExecutionTrigger.properties.type 为 'RunOnce' 时，这是必填字段;当 ExecutionTrigger.properties.type 为 'OnSchedule' 时，不应出现此属性

参数属性

类型:	DateTime
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-SubscriptionId

目标订阅的 ID。 该值必须是 UUID。

参数属性

类型:	String
默认值:	(Get-AzContext).Subscription.Id
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-TargetExcludePrefix

要从任务执行中排除的对象前缀列表。 如果包含和排除前缀之间存在冲突，则排除前缀将是确定因素

参数属性

类型:	String[]
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-TargetPrefix

要为任务执行包含的对象前缀所需的列表

参数属性

类型:	String[]
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-TaskId

相应存储任务的 ID

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-TriggerType

存储任务分配执行的触发器类型

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 命令脚本未运行。

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False
别名:	无线

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

CommonParameters

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。

输出

IStorageTaskAssignment