diff --git a/src/StorageMover/StorageMover.Autorest/README.md b/src/StorageMover/StorageMover.Autorest/README.md index 28e3833c557b..f7ef05175e5c 100644 --- a/src/StorageMover/StorageMover.Autorest/README.md +++ b/src/StorageMover/StorageMover.Autorest/README.md @@ -3,7 +3,6 @@ This directory contains the PowerShell module for the StorageMover service. --- - ## Info - Modifiable: yes - Generated: all diff --git a/src/StorageMover/StorageMover/Az.StorageMover.psd1 b/src/StorageMover/StorageMover/Az.StorageMover.psd1 index ce14c45497bb..090b8531a5a5 100644 --- a/src/StorageMover/StorageMover/Az.StorageMover.psd1 +++ b/src/StorageMover/StorageMover/Az.StorageMover.psd1 @@ -3,7 +3,7 @@ # # Generated by: Microsoft Corporation # -# Generated on: 12/27/2023 +# Generated on: 3/17/2024 # @{ @@ -51,16 +51,16 @@ DotNetFrameworkVersion = '4.7.2' # ProcessorArchitecture = '' # Modules that must be imported into the global environment prior to importing this module -RequiredModules = @(@{ModuleName = 'Az.Accounts'; ModuleVersion = '2.15.0'; }) +RequiredModules = @(@{ModuleName = 'Az.Accounts'; ModuleVersion = '2.16.0'; }) # Assemblies that must be loaded prior to importing this module RequiredAssemblies = 'StorageMover.Autorest/bin/Az.StorageMover.private.dll' # Script files (.ps1) that are run in the caller's environment prior to importing this module. -# ScriptsToProcess = @() +ScriptsToProcess = @() # Type files (.ps1xml) to be loaded when importing this module -# TypesToProcess = @() +TypesToProcess = @() # Format files (.ps1xml) to be loaded when importing this module FormatsToProcess = 'StorageMover.Autorest/Az.StorageMover.format.ps1xml' @@ -113,7 +113,7 @@ PrivateData = @{ PSData = @{ # Tags applied to this module. These help with module discovery in online galleries. - Tags = 'Azure','ResourceManager','ARM','PSModule','StorageMover' + Tags = 'Azure', 'ResourceManager', 'ARM', 'PSModule', 'StorageMover' # A URL to the license for this module. LicenseUri = 'https://aka.ms/azps-license' @@ -138,7 +138,7 @@ PrivateData = @{ } # End of PSData hashtable - } # End of PrivateData hashtable +} # End of PrivateData hashtable # HelpInfo URI of this module # HelpInfoURI = '' diff --git a/src/StorageMover/StorageMover/help/Az.StorageMover.md b/src/StorageMover/StorageMover/help/Az.StorageMover.md index b96290ec156c..6ed7de8cdd2d 100644 --- a/src/StorageMover/StorageMover/help/Az.StorageMover.md +++ b/src/StorageMover/StorageMover/help/Az.StorageMover.md @@ -32,6 +32,9 @@ Gets a Project resource. ### [New-AzStorageMover](New-AzStorageMover.md) Creates or updates a top-level Storage Mover resource. +### [New-AzStorageMoverAzSmbFileShareEndpoint](New-AzStorageMoverAzSmbFileShareEndpoint.md) +Creates a Smb file share endpoint resource, which represents a data transfer source or destination. + ### [New-AzStorageMoverAzStorageContainerEndpoint](New-AzStorageMoverAzStorageContainerEndpoint.md) Creates an AzStorageContainer endpoint resource, which represents a data transfer source or destination. @@ -47,9 +50,6 @@ Creates or updates a Project resource, which is a logical grouping of related jo ### [New-AzStorageMoverSmbEndpoint](New-AzStorageMoverSmbEndpoint.md) Creates an SMB endpoint resource, which represents a data transfer source or destination. -### [New-AzStorageMoverSmbFileShareEndpoint](New-AzStorageMoverSmbFileShareEndpoint.md) -Creates a Smb file share endpoint resource, which represents a data transfer source or destination. - ### [Remove-AzStorageMover](Remove-AzStorageMover.md) Deletes a Storage Mover resource. @@ -78,6 +78,10 @@ Properties not specified in the request body will be unchanged. ### [Update-AzStorageMoverAgent](Update-AzStorageMoverAgent.md) Creates or updates an Agent resource. +### [Update-AzStorageMoverAzSmbFileShareEndpoint](Update-AzStorageMoverAzSmbFileShareEndpoint.md) +Updates properties for a SMB file share endpoint resource. +Properties not specified in the request body will be unchanged. + ### [Update-AzStorageMoverAzStorageContainerEndpoint](Update-AzStorageMoverAzStorageContainerEndpoint.md) Updates properties for an AzStorageContainer endpoint resource. Properties not specified in the request body will be unchanged. @@ -98,7 +102,3 @@ Properties not specified in the request body will be unchanged. Updates properties for a SMB endpoint resource. Properties not specified in the request body will be unchanged. -### [Update-AzStorageMoverSmbFileShareEndpoint](Update-AzStorageMoverSmbFileShareEndpoint.md) -Updates properties for a SMB file share endpoint resource. -Properties not specified in the request body will be unchanged. - diff --git a/src/StorageMover/StorageMover/help/Get-AzStorageMover.md b/src/StorageMover/StorageMover/help/Get-AzStorageMover.md index ffacc62c12f5..30e393fd2ffa 100644 --- a/src/StorageMover/StorageMover/help/Get-AzStorageMover.md +++ b/src/StorageMover/StorageMover/help/Get-AzStorageMover.md @@ -14,24 +14,26 @@ Gets a Storage Mover resource. ### List (Default) ``` -Get-AzStorageMover [-SubscriptionId ] [-DefaultProfile ] [] +Get-AzStorageMover [-SubscriptionId ] [-DefaultProfile ] + [-ProgressAction ] [] ``` ### Get ``` Get-AzStorageMover -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### List1 ``` Get-AzStorageMover -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] - [] + [-ProgressAction ] [] ``` ### GetViaIdentity ``` -Get-AzStorageMover -InputObject [-DefaultProfile ] [] +Get-AzStorageMover -InputObject [-DefaultProfile ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -183,6 +185,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/StorageMover/StorageMover/help/Get-AzStorageMoverAgent.md b/src/StorageMover/StorageMover/help/Get-AzStorageMoverAgent.md index 583441bbaf8e..e24b9cccf9fd 100644 --- a/src/StorageMover/StorageMover/help/Get-AzStorageMoverAgent.md +++ b/src/StorageMover/StorageMover/help/Get-AzStorageMoverAgent.md @@ -15,18 +15,20 @@ Gets an Agent resource. ### List (Default) ``` Get-AzStorageMoverAgent -ResourceGroupName -StorageMoverName [-SubscriptionId ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### Get ``` Get-AzStorageMoverAgent -Name -ResourceGroupName -StorageMoverName - [-SubscriptionId ] [-DefaultProfile ] [] + [-SubscriptionId ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ### GetViaIdentity ``` -Get-AzStorageMoverAgent -InputObject [-DefaultProfile ] [] +Get-AzStorageMoverAgent -InputObject [-DefaultProfile ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -147,6 +149,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/StorageMover/StorageMover/help/Get-AzStorageMoverEndpoint.md b/src/StorageMover/StorageMover/help/Get-AzStorageMoverEndpoint.md index a3d9544924ac..b5a0ede7ae28 100644 --- a/src/StorageMover/StorageMover/help/Get-AzStorageMoverEndpoint.md +++ b/src/StorageMover/StorageMover/help/Get-AzStorageMoverEndpoint.md @@ -15,19 +15,20 @@ Gets an Endpoint resource. ### List (Default) ``` Get-AzStorageMoverEndpoint -ResourceGroupName -StorageMoverName [-SubscriptionId ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### Get ``` Get-AzStorageMoverEndpoint -Name -ResourceGroupName -StorageMoverName - [-SubscriptionId ] [-DefaultProfile ] [] + [-SubscriptionId ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ### GetViaIdentity ``` Get-AzStorageMoverEndpoint -InputObject [-DefaultProfile ] - [] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -150,6 +151,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/StorageMover/StorageMover/help/Get-AzStorageMoverJobDefinition.md b/src/StorageMover/StorageMover/help/Get-AzStorageMoverJobDefinition.md index f42703cf4efe..4da2db37454b 100644 --- a/src/StorageMover/StorageMover/help/Get-AzStorageMoverJobDefinition.md +++ b/src/StorageMover/StorageMover/help/Get-AzStorageMoverJobDefinition.md @@ -15,19 +15,21 @@ Gets a Job Definition resource. ### List (Default) ``` Get-AzStorageMoverJobDefinition -ProjectName -ResourceGroupName -StorageMoverName - [-SubscriptionId ] [-DefaultProfile ] [] + [-SubscriptionId ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ### Get ``` Get-AzStorageMoverJobDefinition -Name -ProjectName -ResourceGroupName - -StorageMoverName [-SubscriptionId ] [-DefaultProfile ] [] + -StorageMoverName [-SubscriptionId ] [-DefaultProfile ] + [-ProgressAction ] [] ``` ### GetViaIdentity ``` Get-AzStorageMoverJobDefinition -InputObject [-DefaultProfile ] - [] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -150,6 +152,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ProjectName The name of the Project resource. diff --git a/src/StorageMover/StorageMover/help/Get-AzStorageMoverJobRun.md b/src/StorageMover/StorageMover/help/Get-AzStorageMoverJobRun.md index 2b295f43bdf7..817815781ac8 100644 --- a/src/StorageMover/StorageMover/help/Get-AzStorageMoverJobRun.md +++ b/src/StorageMover/StorageMover/help/Get-AzStorageMoverJobRun.md @@ -15,19 +15,21 @@ Gets a Job Run resource. ### List (Default) ``` Get-AzStorageMoverJobRun -JobDefinitionName -ProjectName -ResourceGroupName - -StorageMoverName [-SubscriptionId ] [-DefaultProfile ] [] + -StorageMoverName [-SubscriptionId ] [-DefaultProfile ] + [-ProgressAction ] [] ``` ### Get ``` Get-AzStorageMoverJobRun -JobDefinitionName -Name -ProjectName -ResourceGroupName -StorageMoverName [-SubscriptionId ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### GetViaIdentity ``` -Get-AzStorageMoverJobRun -InputObject [-DefaultProfile ] [] +Get-AzStorageMoverJobRun -InputObject [-DefaultProfile ] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -205,6 +207,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ProjectName The name of the Project resource. diff --git a/src/StorageMover/StorageMover/help/Get-AzStorageMoverProject.md b/src/StorageMover/StorageMover/help/Get-AzStorageMoverProject.md index 5a2786a0d7fd..5052474dba37 100644 --- a/src/StorageMover/StorageMover/help/Get-AzStorageMoverProject.md +++ b/src/StorageMover/StorageMover/help/Get-AzStorageMoverProject.md @@ -15,19 +15,20 @@ Gets a Project resource. ### List (Default) ``` Get-AzStorageMoverProject -ResourceGroupName -StorageMoverName [-SubscriptionId ] - [-DefaultProfile ] [] + [-DefaultProfile ] [-ProgressAction ] [] ``` ### Get ``` Get-AzStorageMoverProject -Name -ResourceGroupName -StorageMoverName - [-SubscriptionId ] [-DefaultProfile ] [] + [-SubscriptionId ] [-DefaultProfile ] [-ProgressAction ] + [] ``` ### GetViaIdentity ``` Get-AzStorageMoverProject -InputObject [-DefaultProfile ] - [] + [-ProgressAction ] [] ``` ## DESCRIPTION @@ -138,6 +139,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/StorageMover/StorageMover/help/New-AzStorageMover.md b/src/StorageMover/StorageMover/help/New-AzStorageMover.md index 3834b6981b65..21eb5ba3d74e 100644 --- a/src/StorageMover/StorageMover/help/New-AzStorageMover.md +++ b/src/StorageMover/StorageMover/help/New-AzStorageMover.md @@ -15,14 +15,15 @@ Creates or updates a top-level Storage Mover resource. ### CreateExpanded (Default) ``` New-AzStorageMover -Name -ResourceGroupName [-SubscriptionId ] -Location - [-Description ] [-Tag ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] + [-Description ] [-Tag ] [-DefaultProfile ] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ### Create ``` New-AzStorageMover -Name -ResourceGroupName [-SubscriptionId ] - -StorageMover [-DefaultProfile ] [-WhatIf] [-Confirm] [] + -StorageMover [-DefaultProfile ] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -118,6 +119,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/StorageMover/StorageMover/help/New-AzStorageMoverAzSmbFileShareEndpoint.md b/src/StorageMover/StorageMover/help/New-AzStorageMoverAzSmbFileShareEndpoint.md index a669b5afff70..c4012609e34e 100644 --- a/src/StorageMover/StorageMover/help/New-AzStorageMoverAzSmbFileShareEndpoint.md +++ b/src/StorageMover/StorageMover/help/New-AzStorageMoverAzSmbFileShareEndpoint.md @@ -15,7 +15,7 @@ Creates a Smb file share endpoint resource, which represents a data transfer sou ``` New-AzStorageMoverAzSmbFileShareEndpoint -Name -ResourceGroupName -StorageMoverName [-SubscriptionId ] -StorageAccountResourceId -FileShareName [-Description ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -23,18 +23,39 @@ Creates a Smb file share endpoint resource, which represents a data transfer sou ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Create an Smb file share endpoint +```powershell New-AzStorageMoverAzSmbFileShareEndpoint -Name "myendpoint" -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -StorageAccountResourceId $accountresourceid -FileShareName testfs -Description "New smb file share endpoint" ``` +```output +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.StorageMover/storageMovers/mystoragemover/endpoints/myendpoint +Name : myendpoint +Property : { + "endpointType": "AzureStorageSmbFileShare", + "description": "New smb file share endpoint", + "provisioningState": "Succeeded", + "storageAccountResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.Storage/storageAccounts/myaccount", + "fileShareName": "testfs" + } +SystemDataCreatedAt : 6/27/2023 4:30:13 AM +SystemDataCreatedBy :00000000-0000-0000-0000-000000000000 +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 7/13/2023 7:21:21 AM +SystemDataLastModifiedBy : 00000000-0000-0000-0000-000000000000 +SystemDataLastModifiedByType : Application +Type : microsoft.storagemover/storagemovers/endpoints +``` + +This command creats an Azure Storage SMB file share endpoint. + ## PARAMETERS ### -DefaultProfile The credentials, account, tenant, and subscription used for communication with Azure. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -49,7 +70,7 @@ Accept wildcard characters: False A description for the endpoint. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -64,7 +85,7 @@ Accept wildcard characters: False The name of the Azure Storage file share. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -79,7 +100,7 @@ Accept wildcard characters: False The name of the endpoint resource. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: EndpointName @@ -90,12 +111,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -110,7 +146,7 @@ Accept wildcard characters: False The Azure Resource ID of the storage account that is the target destination. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -125,7 +161,7 @@ Accept wildcard characters: False The name of the Storage Mover resource. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -140,13 +176,13 @@ Accept wildcard characters: False The ID of the target subscription. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -155,7 +191,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -171,7 +207,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -188,13 +224,17 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IEndpoint + ### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IEndpoint + ## NOTES -## RELATED LINKS +ALIASES -[https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemoverazsmbfileshareendpoint](https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemoverazsmbfileshareendpoint) +New-AzStorageMoverSmbFileShareEndpoint +## RELATED LINKS diff --git a/src/StorageMover/StorageMover/help/New-AzStorageMoverAzStorageContainerEndpoint.md b/src/StorageMover/StorageMover/help/New-AzStorageMoverAzStorageContainerEndpoint.md index 3bdac2e10857..734027412b77 100644 --- a/src/StorageMover/StorageMover/help/New-AzStorageMoverAzStorageContainerEndpoint.md +++ b/src/StorageMover/StorageMover/help/New-AzStorageMoverAzStorageContainerEndpoint.md @@ -15,8 +15,8 @@ Creates an AzStorageContainer endpoint resource, which represents a data transfe ``` New-AzStorageMoverAzStorageContainerEndpoint -Name -ResourceGroupName -StorageMoverName [-SubscriptionId ] -BlobContainerName - -StorageAccountResourceId [-Description ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] + -StorageAccountResourceId [-Description ] [-DefaultProfile ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -111,6 +111,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/StorageMover/StorageMover/help/New-AzStorageMoverJobDefinition.md b/src/StorageMover/StorageMover/help/New-AzStorageMoverJobDefinition.md index ead1359aed78..83e529751a7b 100644 --- a/src/StorageMover/StorageMover/help/New-AzStorageMoverJobDefinition.md +++ b/src/StorageMover/StorageMover/help/New-AzStorageMoverJobDefinition.md @@ -17,14 +17,15 @@ Creates or updates a Job Definition resource, which contains configuration for a New-AzStorageMoverJobDefinition -Name -ProjectName -ResourceGroupName -StorageMoverName [-SubscriptionId ] -CopyMode -SourceName -TargetName [-AgentName ] [-Description ] [-SourceSubpath ] - [-TargetSubpath ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-TargetSubpath ] [-DefaultProfile ] [-ProgressAction ] [-WhatIf] + [-Confirm] [] ``` ### Create ``` New-AzStorageMoverJobDefinition -Name -ProjectName -ResourceGroupName -StorageMoverName [-SubscriptionId ] -JobDefinition - [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -160,6 +161,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ProjectName The name of the Project resource. diff --git a/src/StorageMover/StorageMover/help/New-AzStorageMoverNfsEndpoint.md b/src/StorageMover/StorageMover/help/New-AzStorageMoverNfsEndpoint.md index 9dab2a51684b..7511860c4d32 100644 --- a/src/StorageMover/StorageMover/help/New-AzStorageMoverNfsEndpoint.md +++ b/src/StorageMover/StorageMover/help/New-AzStorageMoverNfsEndpoint.md @@ -15,7 +15,7 @@ Creates a Nfs endpoint resource, which represents a data transfer source or dest ``` New-AzStorageMoverNfsEndpoint -Name -ResourceGroupName -StorageMoverName [-SubscriptionId ] -Host -Export [-NfsVersion ] [-Description ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -140,6 +140,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/StorageMover/StorageMover/help/New-AzStorageMoverProject.md b/src/StorageMover/StorageMover/help/New-AzStorageMoverProject.md index b75cc2e63244..1c66940c07ff 100644 --- a/src/StorageMover/StorageMover/help/New-AzStorageMoverProject.md +++ b/src/StorageMover/StorageMover/help/New-AzStorageMoverProject.md @@ -15,15 +15,15 @@ Creates or updates a Project resource, which is a logical grouping of related jo ### CreateExpanded (Default) ``` New-AzStorageMoverProject -Name -ResourceGroupName -StorageMoverName - [-SubscriptionId ] [-Description ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] + [-SubscriptionId ] [-Description ] [-DefaultProfile ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### Create ``` New-AzStorageMoverProject -Name -ResourceGroupName -StorageMoverName - [-SubscriptionId ] -Project [-DefaultProfile ] [-WhatIf] [-Confirm] - [] + [-SubscriptionId ] -Project [-DefaultProfile ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -101,6 +101,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Project The Project resource. To construct, see NOTES section for PROJECT properties and create a hash table. diff --git a/src/StorageMover/StorageMover/help/New-AzStorageMoverSmbEndpoint.md b/src/StorageMover/StorageMover/help/New-AzStorageMoverSmbEndpoint.md index 51399bb5d26e..dbfbe414ad13 100644 --- a/src/StorageMover/StorageMover/help/New-AzStorageMoverSmbEndpoint.md +++ b/src/StorageMover/StorageMover/help/New-AzStorageMoverSmbEndpoint.md @@ -15,8 +15,8 @@ Creates an SMB endpoint resource, which represents a data transfer source or des ``` New-AzStorageMoverSmbEndpoint -Name -ResourceGroupName -StorageMoverName [-SubscriptionId ] -Host -ShareName [-CredentialsUsernameUri ] - [-CredentialsPasswordUri ] [-Description ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] + [-CredentialsPasswordUri ] [-Description ] [-DefaultProfile ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -148,6 +148,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/StorageMover/StorageMover/help/Remove-AzStorageMover.md b/src/StorageMover/StorageMover/help/Remove-AzStorageMover.md index 9d0c7b87010f..e900d83ded31 100644 --- a/src/StorageMover/StorageMover/help/Remove-AzStorageMover.md +++ b/src/StorageMover/StorageMover/help/Remove-AzStorageMover.md @@ -15,13 +15,14 @@ Deletes a Storage Mover resource. ### Delete (Default) ``` Remove-AzStorageMover -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-Force] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-Force] [-AsJob] [-NoWait] [-PassThru] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentity ``` Remove-AzStorageMover -InputObject [-DefaultProfile ] [-Force] [-AsJob] - [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] + [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -143,6 +144,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/StorageMover/StorageMover/help/Remove-AzStorageMoverEndpoint.md b/src/StorageMover/StorageMover/help/Remove-AzStorageMoverEndpoint.md index 681fbafcd5ba..5f878662f157 100644 --- a/src/StorageMover/StorageMover/help/Remove-AzStorageMoverEndpoint.md +++ b/src/StorageMover/StorageMover/help/Remove-AzStorageMoverEndpoint.md @@ -15,14 +15,14 @@ Deletes an Endpoint resource. ### Delete (Default) ``` Remove-AzStorageMoverEndpoint -Name -ResourceGroupName -StorageMoverName - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] - [] + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentity ``` Remove-AzStorageMoverEndpoint -InputObject [-DefaultProfile ] [-AsJob] - [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] + [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -131,6 +131,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/StorageMover/StorageMover/help/Remove-AzStorageMoverJobDefinition.md b/src/StorageMover/StorageMover/help/Remove-AzStorageMoverJobDefinition.md index d52061cdd32e..3f08bc040317 100644 --- a/src/StorageMover/StorageMover/help/Remove-AzStorageMoverJobDefinition.md +++ b/src/StorageMover/StorageMover/help/Remove-AzStorageMoverJobDefinition.md @@ -16,13 +16,13 @@ Deletes a Job Definition resource. ``` Remove-AzStorageMoverJobDefinition -Name -ProjectName -ResourceGroupName -StorageMoverName [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] - [-PassThru] [-WhatIf] [-Confirm] [] + [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentity ``` Remove-AzStorageMoverJobDefinition -InputObject [-DefaultProfile ] [-AsJob] - [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] + [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -131,6 +131,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ProjectName The name of the Project resource. diff --git a/src/StorageMover/StorageMover/help/Remove-AzStorageMoverProject.md b/src/StorageMover/StorageMover/help/Remove-AzStorageMoverProject.md index aa6b26a10084..1f959e0c33f7 100644 --- a/src/StorageMover/StorageMover/help/Remove-AzStorageMoverProject.md +++ b/src/StorageMover/StorageMover/help/Remove-AzStorageMoverProject.md @@ -15,14 +15,14 @@ Deletes a Project resource. ### Delete (Default) ``` Remove-AzStorageMoverProject -Name -ResourceGroupName -StorageMoverName - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] - [] + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentity ``` Remove-AzStorageMoverProject -InputObject [-DefaultProfile ] [-AsJob] - [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] + [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -131,6 +131,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/StorageMover/StorageMover/help/Start-AzStorageMoverJobDefinition.md b/src/StorageMover/StorageMover/help/Start-AzStorageMoverJobDefinition.md index 833fda0a645f..f68d467e7190 100644 --- a/src/StorageMover/StorageMover/help/Start-AzStorageMoverJobDefinition.md +++ b/src/StorageMover/StorageMover/help/Start-AzStorageMoverJobDefinition.md @@ -15,14 +15,14 @@ Requests an Agent to start a new instance of this Job Definition, generating a n ### Start (Default) ``` Start-AzStorageMoverJobDefinition -JobDefinitionName -ProjectName -ResourceGroupName - -StorageMoverName [-SubscriptionId ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] + -StorageMoverName [-SubscriptionId ] [-DefaultProfile ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### StartViaIdentity ``` -Start-AzStorageMoverJobDefinition -InputObject [-DefaultProfile ] [-WhatIf] - [-Confirm] [] +Start-AzStorageMoverJobDefinition -InputObject [-DefaultProfile ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -96,6 +96,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ProjectName The name of the Project resource. diff --git a/src/StorageMover/StorageMover/help/Stop-AzStorageMoverJobDefinition.md b/src/StorageMover/StorageMover/help/Stop-AzStorageMoverJobDefinition.md index a56cc26b3345..8ceffa6157c5 100644 --- a/src/StorageMover/StorageMover/help/Stop-AzStorageMoverJobDefinition.md +++ b/src/StorageMover/StorageMover/help/Stop-AzStorageMoverJobDefinition.md @@ -15,14 +15,14 @@ Requests the Agent of any active instance of this Job Definition to stop. ### Stop (Default) ``` Stop-AzStorageMoverJobDefinition -JobDefinitionName -ProjectName -ResourceGroupName - -StorageMoverName [-SubscriptionId ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] + -StorageMoverName [-SubscriptionId ] [-DefaultProfile ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### StopViaIdentity ``` -Stop-AzStorageMoverJobDefinition -InputObject [-DefaultProfile ] [-WhatIf] - [-Confirm] [] +Stop-AzStorageMoverJobDefinition -InputObject [-DefaultProfile ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -90,6 +90,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ProjectName The name of the Project resource. diff --git a/src/StorageMover/StorageMover/help/Unregister-AzStorageMoverAgent.md b/src/StorageMover/StorageMover/help/Unregister-AzStorageMoverAgent.md index 5e2dd9a64514..b98a707cf09f 100644 --- a/src/StorageMover/StorageMover/help/Unregister-AzStorageMoverAgent.md +++ b/src/StorageMover/StorageMover/help/Unregister-AzStorageMoverAgent.md @@ -15,14 +15,14 @@ Deletes an agent resource. ### Delete (Default) ``` Unregister-AzStorageMoverAgent -Name -ResourceGroupName -StorageMoverName - [-SubscriptionId ] [-DefaultProfile ] [-Force] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] - [-Confirm] [] + [-SubscriptionId ] [-DefaultProfile ] [-Force] [-AsJob] [-NoWait] [-PassThru] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentity ``` Unregister-AzStorageMoverAgent -InputObject [-DefaultProfile ] [-Force] - [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] + [-AsJob] [-NoWait] [-PassThru] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -144,6 +144,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/StorageMover/StorageMover/help/Update-AzStorageMover.md b/src/StorageMover/StorageMover/help/Update-AzStorageMover.md index 823d2fcf7375..84d42048d1c9 100644 --- a/src/StorageMover/StorageMover/help/Update-AzStorageMover.md +++ b/src/StorageMover/StorageMover/help/Update-AzStorageMover.md @@ -16,27 +16,27 @@ Properties not specified in the request body will be unchanged. ### UpdateExpanded (Default) ``` Update-AzStorageMover -Name -ResourceGroupName [-SubscriptionId ] - [-Description ] [-Tag ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] + [-Description ] [-Tag ] [-DefaultProfile ] [-ProgressAction ] + [-WhatIf] [-Confirm] [] ``` ### Update ``` Update-AzStorageMover -Name -ResourceGroupName [-SubscriptionId ] - -StorageMover [-DefaultProfile ] [-WhatIf] [-Confirm] - [] + -StorageMover [-DefaultProfile ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityExpanded ``` Update-AzStorageMover -InputObject [-Description ] [-Tag ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentity ``` Update-AzStorageMover -InputObject -StorageMover - [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -133,6 +133,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/StorageMover/StorageMover/help/Update-AzStorageMoverAgent.md b/src/StorageMover/StorageMover/help/Update-AzStorageMoverAgent.md index e176dd0b4e9e..8664c06f0c5f 100644 --- a/src/StorageMover/StorageMover/help/Update-AzStorageMoverAgent.md +++ b/src/StorageMover/StorageMover/help/Update-AzStorageMoverAgent.md @@ -15,27 +15,27 @@ Creates or updates an Agent resource. ### UpdateExpanded (Default) ``` Update-AzStorageMoverAgent -Name -ResourceGroupName -StorageMoverName - [-SubscriptionId ] [-Description ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] + [-SubscriptionId ] [-Description ] [-DefaultProfile ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### Update ``` Update-AzStorageMoverAgent -Name -ResourceGroupName -StorageMoverName - [-SubscriptionId ] -Agent [-DefaultProfile ] [-WhatIf] [-Confirm] - [] + [-SubscriptionId ] -Agent [-DefaultProfile ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityExpanded ``` Update-AzStorageMoverAgent -InputObject [-Description ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentity ``` Update-AzStorageMoverAgent -InputObject -Agent - [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -155,6 +155,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/StorageMover/StorageMover/help/Update-AzStorageMoverAzSmbFileShareEndpoint.md b/src/StorageMover/StorageMover/help/Update-AzStorageMoverAzSmbFileShareEndpoint.md index 9d1c8ff968e9..33d475cba3a5 100644 --- a/src/StorageMover/StorageMover/help/Update-AzStorageMoverAzSmbFileShareEndpoint.md +++ b/src/StorageMover/StorageMover/help/Update-AzStorageMoverAzSmbFileShareEndpoint.md @@ -17,13 +17,13 @@ Properties not specified in the request body will be unchanged. ``` Update-AzStorageMoverAzSmbFileShareEndpoint -Name -ResourceGroupName -StorageMoverName [-SubscriptionId ] [-Description ] [-DefaultProfile ] - [-WhatIf] [-Confirm] [] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityExpanded ``` Update-AzStorageMoverAzSmbFileShareEndpoint -InputObject [-Description ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -32,23 +32,65 @@ Properties not specified in the request body will be unchanged. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Update a Smb file share endpoint +```powershell Update-AzStorageMoverAzSmbFileShareEndpoint -Name "myendpoint" -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -Description "updated endpoint" ``` -### EXAMPLE 2 +```output +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.StorageMover/storageMovers/mystoragemover/endpoints/myendpoint +Name : myendpoint +Property : { + "endpointType": "AzureStorageSmbFileShare", + "description": "updated endpoint", + "provisioningState": "Succeeded", + "storageAccountResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.Storage/storageAccounts/myaccount", + "fileShareName": "testfs" + } +SystemDataCreatedAt : 6/27/2023 4:30:13 AM +SystemDataCreatedBy : 00000000-0000-0000-0000-000000000000 +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 7/13/2023 7:25:59 AM +SystemDataLastModifiedBy : 00000000-0000-0000-0000-000000000000 +SystemDataLastModifiedByType : Application +Type : microsoft.storagemover/storagemovers/endpoints ``` + +This command updates an Azure Storage SMB file share enpdoint's description by manual inputs. + +### Example 2: Update a Smb file share endpoint by pipeline +```powershell Get-AzStorageMoverEndpoint -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -Name "myendpoint" | Update-AzStorageMoverAzSmbFileShareEndpoint -Description "updated endpoint again" ``` +```output +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.StorageMover/storageMovers/mystoragemover/endpoints/myendpoint +Name : myendpoint +Property : { + "endpointType": "AzureStorageSmbFileShare", + "description": "updated endpoint again", + "provisioningState": "Succeeded", + "storageAccountResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegorup/providers/Microsoft.Storage/storageAccounts/myaccount", + "fileShareName": "testfs" + } +SystemDataCreatedAt : 6/27/2023 4:30:13 AM +SystemDataCreatedBy : 00000000-0000-0000-0000-000000000000 +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 7/13/2023 8:21:51 AM +SystemDataLastModifiedBy : 00000000-0000-0000-0000-000000000000 +SystemDataLastModifiedByType : Application +Type : microsoft.storagemover/storagemovers/endpoints +``` + +This command updates an Azure Storage SMB file share endpoint's description by pipeline. + ## PARAMETERS ### -DefaultProfile The credentials, account, tenant, and subscription used for communication with Azure. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -63,7 +105,7 @@ Accept wildcard characters: False A description for the endpoint. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -79,7 +121,7 @@ Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ```yaml -Type: IStorageMoverIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity Parameter Sets: UpdateViaIdentityExpanded Aliases: @@ -94,7 +136,7 @@ Accept wildcard characters: False The name of the endpoint resource. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded Aliases: EndpointName @@ -105,12 +147,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded Aliases: @@ -125,7 +182,7 @@ Accept wildcard characters: False The name of the Storage Mover resource. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded Aliases: @@ -140,13 +197,13 @@ Accept wildcard characters: False The ID of the target subscription. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -155,7 +212,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -171,7 +228,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -188,28 +245,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IEndpoint + ## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[AgentName \\]: The name of the Agent resource. - \[EndpointName \\]: The name of the Endpoint resource. - \[Id \\]: Resource identity path - \[JobDefinitionName \\]: The name of the Job Definition resource. - \[JobRunName \\]: The name of the Job Run resource. - \[ProjectName \\]: The name of the Project resource. - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[StorageMoverName \\]: The name of the Storage Mover resource. - \[SubscriptionId \\]: The ID of the target subscription. -## RELATED LINKS +ALIASES -[https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoverazsmbfileshareendpoint](https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoverazsmbfileshareendpoint) +Update-AzStorageMoverSmbFileShareEndpoint +## RELATED LINKS diff --git a/src/StorageMover/StorageMover/help/Update-AzStorageMoverAzStorageContainerEndpoint.md b/src/StorageMover/StorageMover/help/Update-AzStorageMoverAzStorageContainerEndpoint.md index a3f8d7eb3fa3..69046812ae45 100644 --- a/src/StorageMover/StorageMover/help/Update-AzStorageMoverAzStorageContainerEndpoint.md +++ b/src/StorageMover/StorageMover/help/Update-AzStorageMoverAzStorageContainerEndpoint.md @@ -17,13 +17,13 @@ Properties not specified in the request body will be unchanged. ``` Update-AzStorageMoverAzStorageContainerEndpoint -Name -ResourceGroupName -StorageMoverName [-SubscriptionId ] [-Description ] [-DefaultProfile ] - [-WhatIf] [-Confirm] [] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityExpanded ``` Update-AzStorageMoverAzStorageContainerEndpoint -InputObject [-Description ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -121,6 +121,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/StorageMover/StorageMover/help/Update-AzStorageMoverJobDefinition.md b/src/StorageMover/StorageMover/help/Update-AzStorageMoverJobDefinition.md index 3f794b61e503..c1e60bb5390a 100644 --- a/src/StorageMover/StorageMover/help/Update-AzStorageMoverJobDefinition.md +++ b/src/StorageMover/StorageMover/help/Update-AzStorageMoverJobDefinition.md @@ -17,28 +17,29 @@ Properties not specified in the request body will be unchanged. ``` Update-AzStorageMoverJobDefinition -Name -ProjectName -ResourceGroupName -StorageMoverName [-SubscriptionId ] [-AgentName ] [-CopyMode ] - [-Description ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-Description ] [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### Update ``` Update-AzStorageMoverJobDefinition -Name -ProjectName -ResourceGroupName -StorageMoverName [-SubscriptionId ] -JobDefinition - [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityExpanded ``` Update-AzStorageMoverJobDefinition -InputObject [-AgentName ] - [-CopyMode ] [-Description ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] + [-CopyMode ] [-Description ] [-DefaultProfile ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentity ``` Update-AzStorageMoverJobDefinition -InputObject - -JobDefinition [-DefaultProfile ] [-WhatIf] [-Confirm] - [] + -JobDefinition [-DefaultProfile ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -190,6 +191,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ProjectName The name of the Project resource. diff --git a/src/StorageMover/StorageMover/help/Update-AzStorageMoverNfsEndpoint.md b/src/StorageMover/StorageMover/help/Update-AzStorageMoverNfsEndpoint.md index cf911e78227f..57f5142cd2c7 100644 --- a/src/StorageMover/StorageMover/help/Update-AzStorageMoverNfsEndpoint.md +++ b/src/StorageMover/StorageMover/help/Update-AzStorageMoverNfsEndpoint.md @@ -16,14 +16,14 @@ Properties not specified in the request body will be unchanged. ### UpdateExpanded (Default) ``` Update-AzStorageMoverNfsEndpoint -Name -ResourceGroupName -StorageMoverName - [-SubscriptionId ] [-Description ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] + [-SubscriptionId ] [-Description ] [-DefaultProfile ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityExpanded ``` Update-AzStorageMoverNfsEndpoint -InputObject [-Description ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -121,6 +121,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/StorageMover/StorageMover/help/Update-AzStorageMoverProject.md b/src/StorageMover/StorageMover/help/Update-AzStorageMoverProject.md index 958674dd2813..3d872db9d5b1 100644 --- a/src/StorageMover/StorageMover/help/Update-AzStorageMoverProject.md +++ b/src/StorageMover/StorageMover/help/Update-AzStorageMoverProject.md @@ -16,27 +16,27 @@ Properties not specified in the request body will be unchanged. ### UpdateExpanded (Default) ``` Update-AzStorageMoverProject -Name -ResourceGroupName -StorageMoverName - [-SubscriptionId ] [-Description ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] + [-SubscriptionId ] [-Description ] [-DefaultProfile ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### Update ``` Update-AzStorageMoverProject -Name -ResourceGroupName -StorageMoverName - [-SubscriptionId ] -Project [-DefaultProfile ] [-WhatIf] - [-Confirm] [] + [-SubscriptionId ] -Project [-DefaultProfile ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityExpanded ``` Update-AzStorageMoverProject -InputObject [-Description ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentity ``` Update-AzStorageMoverProject -InputObject -Project - [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -130,6 +130,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Project The Project resource. To construct, see NOTES section for PROJECT properties and create a hash table. diff --git a/src/StorageMover/StorageMover/help/Update-AzStorageMoverSmbEndpoint.md b/src/StorageMover/StorageMover/help/Update-AzStorageMoverSmbEndpoint.md index e71639888a37..b02b0979c18c 100644 --- a/src/StorageMover/StorageMover/help/Update-AzStorageMoverSmbEndpoint.md +++ b/src/StorageMover/StorageMover/help/Update-AzStorageMoverSmbEndpoint.md @@ -17,14 +17,15 @@ Properties not specified in the request body will be unchanged. ``` Update-AzStorageMoverSmbEndpoint -Name -ResourceGroupName -StorageMoverName [-SubscriptionId ] [-CredentialsUsernameUri ] [-CredentialsPasswordUri ] - [-Description ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-Description ] [-DefaultProfile ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] ``` ### UpdateViaIdentityExpanded ``` Update-AzStorageMoverSmbEndpoint -InputObject [-CredentialsUsernameUri ] - [-CredentialsPasswordUri ] [-Description ] [-DefaultProfile ] [-WhatIf] [-Confirm] - [] + [-CredentialsPasswordUri ] [-Description ] [-DefaultProfile ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -190,6 +191,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: System.Management.Automation.ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive.