diff --git a/src/StorageMover/StorageMover.Autorest/Az.StorageMover.psd1 b/src/StorageMover/StorageMover.Autorest/Az.StorageMover.psd1 index 545c1ea35253..46f157fa7d95 100644 --- a/src/StorageMover/StorageMover.Autorest/Az.StorageMover.psd1 +++ b/src/StorageMover/StorageMover.Autorest/Az.StorageMover.psd1 @@ -1,150 +1,24 @@ -# -# Module manifest for module 'Az.StorageMover' -# -# Generated by: Microsoft Corporation -# -# Generated on: 11/6/2023 -# - @{ - -# Script module or binary module file associated with this manifest. -RootModule = './Az.StorageMover.psm1' - -# Version number of this module. -ModuleVersion = '1.2.0' - -# Supported PSEditions -CompatiblePSEditions = 'Core', 'Desktop' - -# ID used to uniquely identify this module -GUID = 'd6053d97-1a9b-4fc6-9bd2-09c5b23b34db' - -# Author of this module -Author = 'Microsoft Corporation' - -# Company or vendor of this module -CompanyName = 'Microsoft Corporation' - -# Copyright statement for this module -Copyright = 'Microsoft Corporation. All rights reserved.' - -# Description of the functionality provided by this module -Description = 'Microsoft Azure PowerShell: StorageMover cmdlets' - -# Minimum version of the PowerShell engine required by this module -PowerShellVersion = '5.1' - -# Name of the PowerShell host required by this module -# PowerShellHostName = '' - -# Minimum version of the PowerShell host required by this module -# PowerShellHostVersion = '' - -# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only. -DotNetFrameworkVersion = '4.7.2' - -# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only. -# ClrVersion = '' - -# Processor architecture (None, X86, Amd64) required by this module -# ProcessorArchitecture = '' - -# Modules that must be imported into the global environment prior to importing this module -RequiredModules = @(@{ModuleName = 'Az.Accounts'; ModuleVersion = '2.13.1'; }) - -# Assemblies that must be loaded prior to importing this module -RequiredAssemblies = './bin/Az.StorageMover.private.dll' - -# Script files (.ps1) that are run in the caller's environment prior to importing this module. -# ScriptsToProcess = @() - -# Type files (.ps1xml) to be loaded when importing this module -# TypesToProcess = @() - -# Format files (.ps1xml) to be loaded when importing this module -FormatsToProcess = './Az.StorageMover.format.ps1xml' - -# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess -# NestedModules = @() - -# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export. -FunctionsToExport = 'Get-AzStorageMover', 'Get-AzStorageMoverAgent', - 'Get-AzStorageMoverEndpoint', 'Get-AzStorageMoverJobDefinition', - 'Get-AzStorageMoverJobRun', 'Get-AzStorageMoverProject', - 'New-AzStorageMover', - 'New-AzStorageMoverAzStorageContainerEndpoint', - 'New-AzStorageMoverJobDefinition', 'New-AzStorageMoverNfsEndpoint', - 'New-AzStorageMoverProject', 'New-AzStorageMoverSmbEndpoint', - 'New-AzStorageMoverSmbFileShareEndpoint', 'Remove-AzStorageMover', - 'Remove-AzStorageMoverEndpoint', - 'Remove-AzStorageMoverJobDefinition', - 'Remove-AzStorageMoverProject', 'Start-AzStorageMoverJobDefinition', - 'Stop-AzStorageMoverJobDefinition', - 'Unregister-AzStorageMoverAgent', 'Update-AzStorageMover', - 'Update-AzStorageMoverAgent', - 'Update-AzStorageMoverAzStorageContainerEndpoint', - 'Update-AzStorageMoverJobDefinition', - 'Update-AzStorageMoverNfsEndpoint', 'Update-AzStorageMoverProject', - 'Update-AzStorageMoverSmbEndpoint', - 'Update-AzStorageMoverSmbFileShareEndpoint' - -# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export. -CmdletsToExport = @() - -# Variables to export from this module -# VariablesToExport = @() - -# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export. -AliasesToExport = '*' - -# DSC resources to export from this module -# DscResourcesToExport = @() - -# List of all modules packaged with this module -# ModuleList = @() - -# List of all files packaged with this module -# FileList = @() - -# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell. -PrivateData = @{ - + GUID = 'd6053d97-1a9b-4fc6-9bd2-09c5b23b34db' + RootModule = './Az.StorageMover.psm1' + ModuleVersion = '1.1.0' + CompatiblePSEditions = 'Core', 'Desktop' + Author = 'Microsoft Corporation' + CompanyName = 'Microsoft Corporation' + Copyright = 'Microsoft Corporation. All rights reserved.' + Description = 'Microsoft Azure PowerShell: StorageMover cmdlets' + PowerShellVersion = '5.1' + DotNetFrameworkVersion = '4.7.2' + RequiredAssemblies = './bin/Az.StorageMover.private.dll' + FormatsToProcess = './Az.StorageMover.format.ps1xml' + FunctionsToExport = 'Get-AzStorageMover', 'Get-AzStorageMoverAgent', 'Get-AzStorageMoverEndpoint', 'Get-AzStorageMoverJobDefinition', 'Get-AzStorageMoverJobRun', 'Get-AzStorageMoverProject', 'New-AzStorageMover', 'New-AzStorageMoverAzSmbFileShareEndpoint', 'New-AzStorageMoverAzStorageContainerEndpoint', 'New-AzStorageMoverJobDefinition', 'New-AzStorageMoverNfsEndpoint', 'New-AzStorageMoverProject', 'New-AzStorageMoverSmbEndpoint', 'Remove-AzStorageMover', 'Remove-AzStorageMoverEndpoint', 'Remove-AzStorageMoverJobDefinition', 'Remove-AzStorageMoverProject', 'Start-AzStorageMoverJobDefinition', 'Stop-AzStorageMoverJobDefinition', 'Unregister-AzStorageMoverAgent', 'Update-AzStorageMover', 'Update-AzStorageMoverAgent', 'Update-AzStorageMoverAzSmbFileShareEndpoint', 'Update-AzStorageMoverAzStorageContainerEndpoint', 'Update-AzStorageMoverJobDefinition', 'Update-AzStorageMoverNfsEndpoint', 'Update-AzStorageMoverProject', 'Update-AzStorageMoverSmbEndpoint', '*' + AliasesToExport = 'New-AzStorageMoverSmbFileShareEndpoint', 'Update-AzStorageMoverSmbFileShareEndpoint', '*' + PrivateData = @{ PSData = @{ - - # Tags applied to this module. These help with module discovery in online galleries. - Tags = 'Azure','ResourceManager','ARM','PSModule','StorageMover' - - # A URL to the license for this module. - LicenseUri = 'https://aka.ms/azps-license' - - # A URL to the main website for this project. - ProjectUri = 'https://github.com/Azure/azure-powershell' - - # A URL to an icon representing this module. - # IconUri = '' - - # ReleaseNotes of this module - # ReleaseNotes = '* Supported SmbFileShareEndpoint and SmbEndpoint' - - # Prerelease string of this module - # Prerelease = '' - - # Flag to indicate whether the module requires explicit user acceptance for install/update/save - # RequireLicenseAcceptance = $false - - # External dependent modules of this module - # ExternalModuleDependencies = @() - - } # End of PSData hashtable - - } # End of PrivateData hashtable - -# HelpInfo URI of this module -# HelpInfoURI = '' - -# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix. -# DefaultCommandPrefix = '' - + Tags = 'Azure', 'ResourceManager', 'ARM', 'PSModule', 'StorageMover' + LicenseUri = 'https://aka.ms/azps-license' + ProjectUri = 'https://github.com/Azure/azure-powershell' + ReleaseNotes = '' + } + } } - diff --git a/src/StorageMover/StorageMover.Autorest/README.md b/src/StorageMover/StorageMover.Autorest/README.md index 90cb63af3420..0ffed1fdd07d 100644 --- a/src/StorageMover/StorageMover.Autorest/README.md +++ b/src/StorageMover/StorageMover.Autorest/README.md @@ -31,10 +31,10 @@ For information on how to develop for `Az.StorageMover`, see [how-to.md](how-to. ``` yaml # Please specify the commit id that includes your features to make sure generated codes stable. -branch: 74948e5fb9b1e1f8b9d58fb65fc81d5cba6b6ced +commit: 74948e5fb9b1e1f8b9d58fb65fc81d5cba6b6ced require: # readme.azure.noprofile.md is the common configuration file - - $(this-folder)/../readme.azure.noprofile.md + - $(this-folder)/../../readme.azure.noprofile.md input-file: - $(repo)/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2023-10-01/storagemover.json @@ -46,6 +46,10 @@ subject-prefix: $(service-name) nested-object-to-string: true identity-correction-for-post: true +# For new modules, please avoid setting 3.x using the use-extension method and instead, use 4.x as the default option +use-extension: + "@autorest/powershell": "3.x" + directive: - where: verb: Set diff --git a/src/StorageMover/StorageMover.Autorest/custom/NewAzStorageMoverSmbFileShareEndpoint.ps1 b/src/StorageMover/StorageMover.Autorest/custom/NewAzStorageMoverAzSmbFileShareEndpoint.ps1 similarity index 94% rename from src/StorageMover/StorageMover.Autorest/custom/NewAzStorageMoverSmbFileShareEndpoint.ps1 rename to src/StorageMover/StorageMover.Autorest/custom/NewAzStorageMoverAzSmbFileShareEndpoint.ps1 index 044c5ece1533..efc563341019 100644 --- a/src/StorageMover/StorageMover.Autorest/custom/NewAzStorageMoverSmbFileShareEndpoint.ps1 +++ b/src/StorageMover/StorageMover.Autorest/custom/NewAzStorageMoverAzSmbFileShareEndpoint.ps1 @@ -20,7 +20,7 @@ Creates a Smb file share endpoint resource, which represents a data transfer sou .Description Creates a Smb file share endpoint resource, which represents a data transfer source or destination. .Example -New-AzStorageMoverSmbFileShareEndpoint -Name $endpointName -ResourceGroupName $rgname -StorageMoverName $storagemovername -StorageAccountResourceId $accountresourceid -FileShareName $fileshareName -Description "Description" +New-AzStorageMoverAzSmbFileShareEndpoint -Name $endpointName -ResourceGroupName $rgname -StorageMoverName $storagemovername -StorageAccountResourceId $accountresourceid -FileShareName $fileshareName -Description "Description" .Inputs Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IEndpoint @@ -34,11 +34,12 @@ 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. .Link -https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemoversmbfileshareendpoint +https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemoverazsmbfileshareendpoint #> -function New-AzStorageMoverSmbFileShareEndpoint { +function New-AzStorageMoverAzSmbFileShareEndpoint { [OutputType([Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IEndpoint])] [CmdletBinding(DefaultParameterSetName = 'CreateExpanded', PositionalBinding =$false, SupportsShouldProcess, ConfirmImpact = 'Medium')] + [Alias("New-AzStorageMoverSmbFileShareEndpoint")] param( [Parameter(ParameterSetName='CreateExpanded', Mandatory)] [Alias('EndpointName')] diff --git a/src/StorageMover/StorageMover.Autorest/custom/UpdateAzStorageMoverSmbFileShareEndpoint.ps1 b/src/StorageMover/StorageMover.Autorest/custom/UpdateAzStorageMoverAzSmbFileShareEndpoint.ps1 similarity index 95% rename from src/StorageMover/StorageMover.Autorest/custom/UpdateAzStorageMoverSmbFileShareEndpoint.ps1 rename to src/StorageMover/StorageMover.Autorest/custom/UpdateAzStorageMoverAzSmbFileShareEndpoint.ps1 index 43f117c849ac..b9cb3bded52b 100644 --- a/src/StorageMover/StorageMover.Autorest/custom/UpdateAzStorageMoverSmbFileShareEndpoint.ps1 +++ b/src/StorageMover/StorageMover.Autorest/custom/UpdateAzStorageMoverAzSmbFileShareEndpoint.ps1 @@ -22,7 +22,7 @@ Properties not specified in the request body will be unchanged. Updates properties for a SMB file share endpoint resource. Properties not specified in the request body will be unchanged. .Example -Update-AzStorageMoverSmbFileShareEndpoint -Name "myendpoint" -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -Description "updated endpoint" +Update-AzStorageMoverAzSmbFileShareEndpoint -Name "myendpoint" -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -Description "updated endpoint" .Inputs Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IEndpointBaseUpdateParameters @@ -51,11 +51,12 @@ INPUTOBJECT: Identity Parameter [SubscriptionId]: The ID of the target subscription. .Link -https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoversmbfileshareendpoint +https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoverazsmbfileshareendpoint #> -function Update-AzStorageMoverSmbFileShareEndpoint { +function Update-AzStorageMoverAzSmbFileShareEndpoint { [OutputType([Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IEndpoint])] [CmdletBinding(DefaultParameterSetName = 'UpdateExpanded', PositionalBinding =$false, SupportsShouldProcess, ConfirmImpact = 'Medium')] + [Alias("Update-AzStorageMoverSmbFileShareEndpoint")] param( [Parameter(ParameterSetName='UpdateExpanded', Mandatory)] [Alias('EndpointName')] diff --git a/src/StorageMover/StorageMover.Autorest/examples/New-AzStorageMoverSmbFileShareEndpoint.md b/src/StorageMover/StorageMover.Autorest/examples/New-AzStorageMoverAzSmbFileShareEndpoint.md similarity index 80% rename from src/StorageMover/StorageMover.Autorest/examples/New-AzStorageMoverSmbFileShareEndpoint.md rename to src/StorageMover/StorageMover.Autorest/examples/New-AzStorageMoverAzSmbFileShareEndpoint.md index 6e1420c74ee3..cc93aeebef16 100644 --- a/src/StorageMover/StorageMover.Autorest/examples/New-AzStorageMoverSmbFileShareEndpoint.md +++ b/src/StorageMover/StorageMover.Autorest/examples/New-AzStorageMoverAzSmbFileShareEndpoint.md @@ -1,6 +1,6 @@ ### Example 1: Create an Smb file share endpoint ```powershell -New-AzStorageMoverSmbFileShareEndpoint -Name "myendpoint" -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -StorageAccountResourceId $accountresourceid -FileShareName testfs -Description "New smb file share endpoint" +New-AzStorageMoverAzSmbFileShareEndpoint -Name "myendpoint" -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -StorageAccountResourceId $accountresourceid -FileShareName testfs -Description "New smb file share endpoint" ``` ```output @@ -22,6 +22,4 @@ SystemDataLastModifiedByType : Application Type : microsoft.storagemover/storagemovers/endpoints ``` -This command creats a Smb file share endpoint - - +This command creats an Azure Storage SMB file share endpoint. diff --git a/src/StorageMover/StorageMover.Autorest/examples/Update-AzStorageMoverSmbFileShareEndpoint.md b/src/StorageMover/StorageMover.Autorest/examples/Update-AzStorageMoverAzSmbFileShareEndpoint.md similarity index 86% rename from src/StorageMover/StorageMover.Autorest/examples/Update-AzStorageMoverSmbFileShareEndpoint.md rename to src/StorageMover/StorageMover.Autorest/examples/Update-AzStorageMoverAzSmbFileShareEndpoint.md index 90233395d1b2..23959fb1041b 100644 --- a/src/StorageMover/StorageMover.Autorest/examples/Update-AzStorageMoverSmbFileShareEndpoint.md +++ b/src/StorageMover/StorageMover.Autorest/examples/Update-AzStorageMoverAzSmbFileShareEndpoint.md @@ -1,6 +1,6 @@ ### Example 1: Update a Smb file share endpoint ```powershell -Update-AzStorageMoverSmbFileShareEndpoint -Name "myendpoint" -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -Description "updated endpoint" +Update-AzStorageMoverAzSmbFileShareEndpoint -Name "myendpoint" -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -Description "updated endpoint" ``` ```output @@ -22,11 +22,11 @@ SystemDataLastModifiedByType : Application Type : microsoft.storagemover/storagemovers/endpoints ``` -This command updates a Smb file share enpdoint's description by manual inputs. +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-AzStorageMoverSmbFileShareEndpoint -Description "updated endpoint again" +Get-AzStorageMoverEndpoint -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -Name "myendpoint" | Update-AzStorageMoverAzSmbFileShareEndpoint -Description "updated endpoint again" ``` ```output @@ -48,5 +48,5 @@ SystemDataLastModifiedByType : Application Type : microsoft.storagemover/storagemovers/endpoints ``` -This command updates a Smb file share endpoint's description by pipeline +This command updates an Azure Storage SMB file share endpoint's description by pipeline. diff --git a/src/StorageMover/StorageMover.Autorest/exports/New-AzStorageMoverSmbFileShareEndpoint.ps1 b/src/StorageMover/StorageMover.Autorest/exports/New-AzStorageMoverAzSmbFileShareEndpoint.ps1 similarity index 95% rename from src/StorageMover/StorageMover.Autorest/exports/New-AzStorageMoverSmbFileShareEndpoint.ps1 rename to src/StorageMover/StorageMover.Autorest/exports/New-AzStorageMoverAzSmbFileShareEndpoint.ps1 index c1e046942355..dd594de2baec 100644 --- a/src/StorageMover/StorageMover.Autorest/exports/New-AzStorageMoverSmbFileShareEndpoint.ps1 +++ b/src/StorageMover/StorageMover.Autorest/exports/New-AzStorageMoverAzSmbFileShareEndpoint.ps1 @@ -20,7 +20,7 @@ Creates a Smb file share endpoint resource, which represents a data transfer sou .Description Creates a Smb file share endpoint resource, which represents a data transfer source or destination. .Example -New-AzStorageMoverSmbFileShareEndpoint -Name "myendpoint" -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -StorageAccountResourceId $accountresourceid -FileShareName testfs -Description "New smb file share endpoint" +New-AzStorageMoverAzSmbFileShareEndpoint -Name "myendpoint" -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -StorageAccountResourceId $accountresourceid -FileShareName testfs -Description "New smb file share endpoint" .Inputs Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IEndpoint @@ -29,9 +29,10 @@ Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity .Outputs Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IEndpoint .Link -https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemoversmbfileshareendpoint +https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemoverazsmbfileshareendpoint #> -function New-AzStorageMoverSmbFileShareEndpoint { +function New-AzStorageMoverAzSmbFileShareEndpoint { +[Alias('New-AzStorageMoverSmbFileShareEndpoint')] [OutputType([Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IEndpoint])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( @@ -154,7 +155,7 @@ begin { } $mapping = @{ - CreateExpanded = 'Az.StorageMover.custom\New-AzStorageMoverSmbFileShareEndpoint'; + CreateExpanded = 'Az.StorageMover.custom\New-AzStorageMoverAzSmbFileShareEndpoint'; } if (('CreateExpanded') -contains $parameterSet -and -not $PSBoundParameters.ContainsKey('SubscriptionId')) { $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id diff --git a/src/StorageMover/StorageMover.Autorest/exports/ProxyCmdletDefinitions.ps1 b/src/StorageMover/StorageMover.Autorest/exports/ProxyCmdletDefinitions.ps1 index b02f3e322215..7ab7c3374632 100644 --- a/src/StorageMover/StorageMover.Autorest/exports/ProxyCmdletDefinitions.ps1 +++ b/src/StorageMover/StorageMover.Autorest/exports/ProxyCmdletDefinitions.ps1 @@ -3940,11 +3940,11 @@ end { <# .Synopsis -Creates an AzStorageContainer endpoint resource, which represents a data transfer source or destination. +Creates a Smb file share endpoint resource, which represents a data transfer source or destination. .Description -Creates an AzStorageContainer endpoint resource, which represents a data transfer source or destination. +Creates a Smb file share endpoint resource, which represents a data transfer source or destination. .Example -New-AzStorageMoverAzStorageContainerEndpoint -Name myEndpoint -ResourceGroupName myResourceGroup -BlobContainerName myContainer -StorageMoverName myStorageMover -StorageAccountResourceId myAccountResourceId +New-AzStorageMoverAzSmbFileShareEndpoint -Name "myendpoint" -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -StorageAccountResourceId $accountresourceid -FileShareName testfs -Description "New smb file share endpoint" .Inputs Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IEndpoint @@ -3953,9 +3953,10 @@ Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity .Outputs Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IEndpoint .Link -https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemoverazstoragecontainerendpoint +https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemoverazsmbfileshareendpoint #> -function New-AzStorageMoverAzStorageContainerEndpoint { +function New-AzStorageMoverAzSmbFileShareEndpoint { +[Alias('New-AzStorageMoverSmbFileShareEndpoint')] [OutputType([Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IEndpoint])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( @@ -3989,14 +3990,14 @@ param( [Parameter(Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Category('Body')] [System.String] - # The name of the Storage blob container that is the target destination. - ${BlobContainerName}, + # The Azure Resource ID of the storage account that is the target destination. + ${StorageAccountResourceId}, [Parameter(Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Category('Body')] [System.String] - # The Azure Resource ID of the storage account that is the target destination. - ${StorageAccountResourceId}, + # The name of the Azure Storage file share. + ${FileShareName}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Category('Body')] @@ -4078,7 +4079,7 @@ begin { } $mapping = @{ - CreateExpanded = 'Az.StorageMover.custom\New-AzStorageMoverAzStorageContainerEndpoint'; + CreateExpanded = 'Az.StorageMover.custom\New-AzStorageMoverAzSmbFileShareEndpoint'; } if (('CreateExpanded') -contains $parameterSet -and -not $PSBoundParameters.ContainsKey('SubscriptionId')) { $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id @@ -4135,11 +4136,11 @@ end { <# .Synopsis -Creates a Nfs endpoint resource, which represents a data transfer source or destination. +Creates an AzStorageContainer endpoint resource, which represents a data transfer source or destination. .Description -Creates a Nfs endpoint resource, which represents a data transfer source or destination. +Creates an AzStorageContainer endpoint resource, which represents a data transfer source or destination. .Example - New-AzStorageMoverNfsEndpoint -Name myEndpoint -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Host "10.0.0.1" -Export "/" -NfsVersion NFSv3 -Description "Description" +New-AzStorageMoverAzStorageContainerEndpoint -Name myEndpoint -ResourceGroupName myResourceGroup -BlobContainerName myContainer -StorageMoverName myStorageMover -StorageAccountResourceId myAccountResourceId .Inputs Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IEndpoint @@ -4148,9 +4149,9 @@ Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity .Outputs Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IEndpoint .Link -https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemovernfsendpoint +https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemoverazstoragecontainerendpoint #> -function New-AzStorageMoverNfsEndpoint { +function New-AzStorageMoverAzStorageContainerEndpoint { [OutputType([Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IEndpoint])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( @@ -4184,21 +4185,14 @@ param( [Parameter(Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Category('Body')] [System.String] - # The host name or IP address of the server exporting the file system. - ${Host}, + # The name of the Storage blob container that is the target destination. + ${BlobContainerName}, [Parameter(Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Category('Body')] [System.String] - # The directory being exported from the server. - ${Export}, - - [Parameter()] - [ArgumentCompleter([Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Support.NfsVersion])] - [Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Category('Body')] - [Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Support.NfsVersion] - # The NFS protocol version. - ${NfsVersion}, + # The Azure Resource ID of the storage account that is the target destination. + ${StorageAccountResourceId}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Category('Body')] @@ -4280,7 +4274,7 @@ begin { } $mapping = @{ - CreateExpanded = 'Az.StorageMover.custom\New-AzStorageMoverNfsEndpoint'; + CreateExpanded = 'Az.StorageMover.custom\New-AzStorageMoverAzStorageContainerEndpoint'; } if (('CreateExpanded') -contains $parameterSet -and -not $PSBoundParameters.ContainsKey('SubscriptionId')) { $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id @@ -4337,11 +4331,11 @@ end { <# .Synopsis -Creates an SMB endpoint resource, which represents a data transfer source or destination. +Creates a Nfs endpoint resource, which represents a data transfer source or destination. .Description -Creates an SMB endpoint resource, which represents a data transfer source or destination. +Creates a Nfs endpoint resource, which represents a data transfer source or destination. .Example -New-AzStorageMoverSmbEndpoint -Name "myendpoint" -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -Host "10.0.0.1" -ShareName "testshare" -CredentialsUsernameUri "https://examples-azureKeyVault.vault.azure.net/secrets/username1" -CredentialsPasswordUri "https://examples-azureKeyVault.vault.azure.net/secrets/password1" + New-AzStorageMoverNfsEndpoint -Name myEndpoint -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Host "10.0.0.1" -Export "/" -NfsVersion NFSv3 -Description "Description" .Inputs Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IEndpoint @@ -4350,9 +4344,9 @@ Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity .Outputs Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IEndpoint .Link -https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemoversmbendpoint +https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemovernfsendpoint #> -function New-AzStorageMoverSmbEndpoint { +function New-AzStorageMoverNfsEndpoint { [OutputType([Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IEndpoint])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( @@ -4392,22 +4386,15 @@ param( [Parameter(Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Category('Body')] [System.String] - # The name of the SMB share being exported from the server - ${ShareName}, - - [Parameter()] - [Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Category('Body')] - [System.String] - # The secret URI which stores the username. - # Use empty string to clean-up existing value. - ${CredentialsUsernameUri}, + # The directory being exported from the server. + ${Export}, [Parameter()] + [ArgumentCompleter([Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Support.NfsVersion])] [Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Category('Body')] - [System.String] - # The secret URI which stores the password. - # Use empty string to clean-up existing value. - ${CredentialsPasswordUri}, + [Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Support.NfsVersion] + # The NFS protocol version. + ${NfsVersion}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Category('Body')] @@ -4489,7 +4476,7 @@ begin { } $mapping = @{ - CreateExpanded = 'Az.StorageMover.custom\New-AzStorageMoverSmbEndpoint'; + CreateExpanded = 'Az.StorageMover.custom\New-AzStorageMoverNfsEndpoint'; } if (('CreateExpanded') -contains $parameterSet -and -not $PSBoundParameters.ContainsKey('SubscriptionId')) { $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id @@ -4546,11 +4533,11 @@ end { <# .Synopsis -Creates a Smb file share endpoint resource, which represents a data transfer source or destination. +Creates an SMB endpoint resource, which represents a data transfer source or destination. .Description -Creates a Smb file share endpoint resource, which represents a data transfer source or destination. +Creates an SMB endpoint resource, which represents a data transfer source or destination. .Example -New-AzStorageMoverSmbFileShareEndpoint -Name "myendpoint" -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -StorageAccountResourceId $accountresourceid -FileShareName testfs -Description "New smb file share endpoint" +New-AzStorageMoverSmbEndpoint -Name "myendpoint" -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -Host "10.0.0.1" -ShareName "testshare" -CredentialsUsernameUri "https://examples-azureKeyVault.vault.azure.net/secrets/username1" -CredentialsPasswordUri "https://examples-azureKeyVault.vault.azure.net/secrets/password1" .Inputs Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IEndpoint @@ -4559,9 +4546,9 @@ Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity .Outputs Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IEndpoint .Link -https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemoversmbfileshareendpoint +https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemoversmbendpoint #> -function New-AzStorageMoverSmbFileShareEndpoint { +function New-AzStorageMoverSmbEndpoint { [OutputType([Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IEndpoint])] [CmdletBinding(DefaultParameterSetName='CreateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( @@ -4595,14 +4582,28 @@ param( [Parameter(Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Category('Body')] [System.String] - # The Azure Resource ID of the storage account that is the target destination. - ${StorageAccountResourceId}, + # The host name or IP address of the server exporting the file system. + ${Host}, [Parameter(Mandatory)] [Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Category('Body')] [System.String] - # The name of the Azure Storage file share. - ${FileShareName}, + # The name of the SMB share being exported from the server + ${ShareName}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Category('Body')] + [System.String] + # The secret URI which stores the username. + # Use empty string to clean-up existing value. + ${CredentialsUsernameUri}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Category('Body')] + [System.String] + # The secret URI which stores the password. + # Use empty string to clean-up existing value. + ${CredentialsPasswordUri}, [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Category('Body')] @@ -4684,7 +4685,7 @@ begin { } $mapping = @{ - CreateExpanded = 'Az.StorageMover.custom\New-AzStorageMoverSmbFileShareEndpoint'; + CreateExpanded = 'Az.StorageMover.custom\New-AzStorageMoverSmbEndpoint'; } if (('CreateExpanded') -contains $parameterSet -and -not $PSBoundParameters.ContainsKey('SubscriptionId')) { $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id @@ -5177,13 +5178,15 @@ end { <# .Synopsis -Updates properties for an AzStorageContainer endpoint resource. +Updates properties for a SMB file share endpoint resource. Properties not specified in the request body will be unchanged. .Description -Updates properties for an AzStorageContainer endpoint resource. +Updates properties for a SMB file share endpoint resource. Properties not specified in the request body will be unchanged. .Example -Update-AzStorageMoverAzStorageContainerEndpoint -Name myEndpoint -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Description "Update Description" +Update-AzStorageMoverAzSmbFileShareEndpoint -Name "myendpoint" -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -Description "updated endpoint" +.Example +Get-AzStorageMoverEndpoint -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -Name "myendpoint" | Update-AzStorageMoverAzSmbFileShareEndpoint -Description "updated endpoint again" .Inputs Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity @@ -5205,9 +5208,10 @@ INPUTOBJECT : Identity Parameter [StorageMoverName ]: The name of the Storage Mover resource. [SubscriptionId ]: The ID of the target subscription. .Link -https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoverazstoragecontainerendpoint +https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoverazsmbfileshareendpoint #> -function Update-AzStorageMoverAzStorageContainerEndpoint { +function Update-AzStorageMoverAzSmbFileShareEndpoint { +[Alias('Update-AzStorageMoverSmbFileShareEndpoint')] [OutputType([Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IEndpoint])] [CmdletBinding(DefaultParameterSetName='UpdateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( @@ -5325,8 +5329,8 @@ begin { } $mapping = @{ - UpdateExpanded = 'Az.StorageMover.custom\Update-AzStorageMoverAzStorageContainerEndpoint'; - UpdateViaIdentityExpanded = 'Az.StorageMover.custom\Update-AzStorageMoverAzStorageContainerEndpoint'; + UpdateExpanded = 'Az.StorageMover.custom\Update-AzStorageMoverAzSmbFileShareEndpoint'; + UpdateViaIdentityExpanded = 'Az.StorageMover.custom\Update-AzStorageMoverAzSmbFileShareEndpoint'; } if (('UpdateExpanded') -contains $parameterSet -and -not $PSBoundParameters.ContainsKey('SubscriptionId')) { $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id @@ -5383,13 +5387,13 @@ end { <# .Synopsis -Updates properties for a Nfs endpoint resource. +Updates properties for an AzStorageContainer endpoint resource. Properties not specified in the request body will be unchanged. .Description -Updates properties for a Nfs endpoint resource. +Updates properties for an AzStorageContainer endpoint resource. Properties not specified in the request body will be unchanged. .Example -Update-AzStorageMoverNfsEndpoint -Name myEndpoint -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Description "Update Description" +Update-AzStorageMoverAzStorageContainerEndpoint -Name myEndpoint -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Description "Update Description" .Inputs Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity @@ -5411,9 +5415,9 @@ INPUTOBJECT : Identity Parameter [StorageMoverName ]: The name of the Storage Mover resource. [SubscriptionId ]: The ID of the target subscription. .Link -https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemovernfsendpoint +https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoverazstoragecontainerendpoint #> -function Update-AzStorageMoverNfsEndpoint { +function Update-AzStorageMoverAzStorageContainerEndpoint { [OutputType([Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IEndpoint])] [CmdletBinding(DefaultParameterSetName='UpdateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( @@ -5531,8 +5535,8 @@ begin { } $mapping = @{ - UpdateExpanded = 'Az.StorageMover.custom\Update-AzStorageMoverNfsEndpoint'; - UpdateViaIdentityExpanded = 'Az.StorageMover.custom\Update-AzStorageMoverNfsEndpoint'; + UpdateExpanded = 'Az.StorageMover.custom\Update-AzStorageMoverAzStorageContainerEndpoint'; + UpdateViaIdentityExpanded = 'Az.StorageMover.custom\Update-AzStorageMoverAzStorageContainerEndpoint'; } if (('UpdateExpanded') -contains $parameterSet -and -not $PSBoundParameters.ContainsKey('SubscriptionId')) { $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id @@ -5589,15 +5593,13 @@ end { <# .Synopsis -Updates properties for a SMB endpoint resource. +Updates properties for a Nfs endpoint resource. Properties not specified in the request body will be unchanged. .Description -Updates properties for a SMB endpoint resource. +Updates properties for a Nfs endpoint resource. Properties not specified in the request body will be unchanged. .Example -Update-AzStorageMoverSmbEndpoint -Name "myendpoint" -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -CredentialsUsernameUri "https://examples-azureKeyVault.vault.azure.net/secrets/username2" -CredentialsPasswordUri "https://examples-azureKeyVault.vault.azure.net/secrets/password2" -Description "update endpoint" -.Example -Get-AzStorageMoverEndpoint -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -Name "myendpoint" | Update-AzStorageMoverSmbEndpoint -CredentialsPasswordUri "" -CredentialsUsernameUri "" -Description "update endpoint again" +Update-AzStorageMoverNfsEndpoint -Name myEndpoint -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Description "Update Description" .Inputs Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity @@ -5619,9 +5621,9 @@ INPUTOBJECT : Identity Parameter [StorageMoverName ]: The name of the Storage Mover resource. [SubscriptionId ]: The ID of the target subscription. .Link -https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoversmbendpoint +https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemovernfsendpoint #> -function Update-AzStorageMoverSmbEndpoint { +function Update-AzStorageMoverNfsEndpoint { [OutputType([Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IEndpoint])] [CmdletBinding(DefaultParameterSetName='UpdateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( @@ -5659,20 +5661,6 @@ param( # To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ${InputObject}, - [Parameter()] - [Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Category('Body')] - [System.String] - # The secret URI which stores the username. - # Use empty string to clean-up existing value. - ${CredentialsUsernameUri}, - - [Parameter()] - [Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Category('Body')] - [System.String] - # The secret URI which stores the password. - # Use empty string to clean-up existing value. - ${CredentialsPasswordUri}, - [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Category('Body')] [System.String] @@ -5753,8 +5741,8 @@ begin { } $mapping = @{ - UpdateExpanded = 'Az.StorageMover.custom\Update-AzStorageMoverSmbEndpoint'; - UpdateViaIdentityExpanded = 'Az.StorageMover.custom\Update-AzStorageMoverSmbEndpoint'; + UpdateExpanded = 'Az.StorageMover.custom\Update-AzStorageMoverNfsEndpoint'; + UpdateViaIdentityExpanded = 'Az.StorageMover.custom\Update-AzStorageMoverNfsEndpoint'; } if (('UpdateExpanded') -contains $parameterSet -and -not $PSBoundParameters.ContainsKey('SubscriptionId')) { $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id @@ -5811,15 +5799,15 @@ end { <# .Synopsis -Updates properties for a SMB file share endpoint resource. +Updates properties for a SMB endpoint resource. Properties not specified in the request body will be unchanged. .Description -Updates properties for a SMB file share endpoint resource. +Updates properties for a SMB endpoint resource. Properties not specified in the request body will be unchanged. .Example -Update-AzStorageMoverSmbFileShareEndpoint -Name "myendpoint" -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -Description "updated endpoint" +Update-AzStorageMoverSmbEndpoint -Name "myendpoint" -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -CredentialsUsernameUri "https://examples-azureKeyVault.vault.azure.net/secrets/username2" -CredentialsPasswordUri "https://examples-azureKeyVault.vault.azure.net/secrets/password2" -Description "update endpoint" .Example -Get-AzStorageMoverEndpoint -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -Name "myendpoint" | Update-AzStorageMoverSmbFileShareEndpoint -Description "updated endpoint again" +Get-AzStorageMoverEndpoint -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -Name "myendpoint" | Update-AzStorageMoverSmbEndpoint -CredentialsPasswordUri "" -CredentialsUsernameUri "" -Description "update endpoint again" .Inputs Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity @@ -5841,9 +5829,9 @@ INPUTOBJECT : Identity Parameter [StorageMoverName ]: The name of the Storage Mover resource. [SubscriptionId ]: The ID of the target subscription. .Link -https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoversmbfileshareendpoint +https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoversmbendpoint #> -function Update-AzStorageMoverSmbFileShareEndpoint { +function Update-AzStorageMoverSmbEndpoint { [OutputType([Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IEndpoint])] [CmdletBinding(DefaultParameterSetName='UpdateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( @@ -5881,6 +5869,20 @@ param( # To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ${InputObject}, + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Category('Body')] + [System.String] + # The secret URI which stores the username. + # Use empty string to clean-up existing value. + ${CredentialsUsernameUri}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Category('Body')] + [System.String] + # The secret URI which stores the password. + # Use empty string to clean-up existing value. + ${CredentialsPasswordUri}, + [Parameter()] [Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Category('Body')] [System.String] @@ -5961,8 +5963,8 @@ begin { } $mapping = @{ - UpdateExpanded = 'Az.StorageMover.custom\Update-AzStorageMoverSmbFileShareEndpoint'; - UpdateViaIdentityExpanded = 'Az.StorageMover.custom\Update-AzStorageMoverSmbFileShareEndpoint'; + UpdateExpanded = 'Az.StorageMover.custom\Update-AzStorageMoverSmbEndpoint'; + UpdateViaIdentityExpanded = 'Az.StorageMover.custom\Update-AzStorageMoverSmbEndpoint'; } if (('UpdateExpanded') -contains $parameterSet -and -not $PSBoundParameters.ContainsKey('SubscriptionId')) { $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id diff --git a/src/StorageMover/StorageMover.Autorest/exports/Update-AzStorageMoverSmbFileShareEndpoint.ps1 b/src/StorageMover/StorageMover.Autorest/exports/Update-AzStorageMoverAzSmbFileShareEndpoint.ps1 similarity index 95% rename from src/StorageMover/StorageMover.Autorest/exports/Update-AzStorageMoverSmbFileShareEndpoint.ps1 rename to src/StorageMover/StorageMover.Autorest/exports/Update-AzStorageMoverAzSmbFileShareEndpoint.ps1 index 727254a4cebf..e783cb64de83 100644 --- a/src/StorageMover/StorageMover.Autorest/exports/Update-AzStorageMoverSmbFileShareEndpoint.ps1 +++ b/src/StorageMover/StorageMover.Autorest/exports/Update-AzStorageMoverAzSmbFileShareEndpoint.ps1 @@ -22,9 +22,9 @@ Properties not specified in the request body will be unchanged. Updates properties for a SMB file share endpoint resource. Properties not specified in the request body will be unchanged. .Example -Update-AzStorageMoverSmbFileShareEndpoint -Name "myendpoint" -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -Description "updated endpoint" +Update-AzStorageMoverAzSmbFileShareEndpoint -Name "myendpoint" -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -Description "updated endpoint" .Example -Get-AzStorageMoverEndpoint -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -Name "myendpoint" | Update-AzStorageMoverSmbFileShareEndpoint -Description "updated endpoint again" +Get-AzStorageMoverEndpoint -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -Name "myendpoint" | Update-AzStorageMoverAzSmbFileShareEndpoint -Description "updated endpoint again" .Inputs Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity @@ -46,9 +46,10 @@ INPUTOBJECT : Identity Parameter [StorageMoverName ]: The name of the Storage Mover resource. [SubscriptionId ]: The ID of the target subscription. .Link -https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoversmbfileshareendpoint +https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoverazsmbfileshareendpoint #> -function Update-AzStorageMoverSmbFileShareEndpoint { +function Update-AzStorageMoverAzSmbFileShareEndpoint { +[Alias('Update-AzStorageMoverSmbFileShareEndpoint')] [OutputType([Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IEndpoint])] [CmdletBinding(DefaultParameterSetName='UpdateExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( @@ -166,8 +167,8 @@ begin { } $mapping = @{ - UpdateExpanded = 'Az.StorageMover.custom\Update-AzStorageMoverSmbFileShareEndpoint'; - UpdateViaIdentityExpanded = 'Az.StorageMover.custom\Update-AzStorageMoverSmbFileShareEndpoint'; + UpdateExpanded = 'Az.StorageMover.custom\Update-AzStorageMoverAzSmbFileShareEndpoint'; + UpdateViaIdentityExpanded = 'Az.StorageMover.custom\Update-AzStorageMoverAzSmbFileShareEndpoint'; } if (('UpdateExpanded') -contains $parameterSet -and -not $PSBoundParameters.ContainsKey('SubscriptionId')) { $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id diff --git a/src/StorageMover/StorageMover.Autorest/help/Az.StorageMover.md b/src/StorageMover/StorageMover.Autorest/help/Az.StorageMover.md new file mode 100644 index 000000000000..6ed7de8cdd2d --- /dev/null +++ b/src/StorageMover/StorageMover.Autorest/help/Az.StorageMover.md @@ -0,0 +1,104 @@ +--- +Module Name: Az.StorageMover +Module Guid: d6053d97-1a9b-4fc6-9bd2-09c5b23b34db +Download Help Link: https://learn.microsoft.com/powershell/module/az.storagemover +Help Version: 1.0.0.0 +Locale: en-US +--- + +# Az.StorageMover Module +## Description +Microsoft Azure PowerShell: StorageMover cmdlets + +## Az.StorageMover Cmdlets +### [Get-AzStorageMover](Get-AzStorageMover.md) +Gets a Storage Mover resource. + +### [Get-AzStorageMoverAgent](Get-AzStorageMoverAgent.md) +Gets an Agent resource. + +### [Get-AzStorageMoverEndpoint](Get-AzStorageMoverEndpoint.md) +Gets an Endpoint resource. + +### [Get-AzStorageMoverJobDefinition](Get-AzStorageMoverJobDefinition.md) +Gets a Job Definition resource. + +### [Get-AzStorageMoverJobRun](Get-AzStorageMoverJobRun.md) +Gets a Job Run resource. + +### [Get-AzStorageMoverProject](Get-AzStorageMoverProject.md) +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. + +### [New-AzStorageMoverJobDefinition](New-AzStorageMoverJobDefinition.md) +Creates or updates a Job Definition resource, which contains configuration for a single unit of managed data transfer. + +### [New-AzStorageMoverNfsEndpoint](New-AzStorageMoverNfsEndpoint.md) +Creates a Nfs endpoint resource, which represents a data transfer source or destination. + +### [New-AzStorageMoverProject](New-AzStorageMoverProject.md) +Creates or updates a Project resource, which is a logical grouping of related jobs. + +### [New-AzStorageMoverSmbEndpoint](New-AzStorageMoverSmbEndpoint.md) +Creates an SMB endpoint resource, which represents a data transfer source or destination. + +### [Remove-AzStorageMover](Remove-AzStorageMover.md) +Deletes a Storage Mover resource. + +### [Remove-AzStorageMoverEndpoint](Remove-AzStorageMoverEndpoint.md) +Deletes an Endpoint resource. + +### [Remove-AzStorageMoverJobDefinition](Remove-AzStorageMoverJobDefinition.md) +Deletes a Job Definition resource. + +### [Remove-AzStorageMoverProject](Remove-AzStorageMoverProject.md) +Deletes a Project resource. + +### [Start-AzStorageMoverJobDefinition](Start-AzStorageMoverJobDefinition.md) +Requests an Agent to start a new instance of this Job Definition, generating a new Job Run resource. + +### [Stop-AzStorageMoverJobDefinition](Stop-AzStorageMoverJobDefinition.md) +Requests the Agent of any active instance of this Job Definition to stop. + +### [Unregister-AzStorageMoverAgent](Unregister-AzStorageMoverAgent.md) +Deletes an agent resource. + +### [Update-AzStorageMover](Update-AzStorageMover.md) +Updates properties for a Storage Mover resource. +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. + +### [Update-AzStorageMoverJobDefinition](Update-AzStorageMoverJobDefinition.md) +Updates properties for a Job Definition resource. +Properties not specified in the request body will be unchanged. + +### [Update-AzStorageMoverNfsEndpoint](Update-AzStorageMoverNfsEndpoint.md) +Updates properties for a Nfs endpoint resource. +Properties not specified in the request body will be unchanged. + +### [Update-AzStorageMoverProject](Update-AzStorageMoverProject.md) +Updates properties for a Project resource. +Properties not specified in the request body will be unchanged. + +### [Update-AzStorageMoverSmbEndpoint](Update-AzStorageMoverSmbEndpoint.md) +Updates properties for a SMB endpoint resource. +Properties not specified in the request body will be unchanged. + diff --git a/src/StorageMover/StorageMover.Autorest/help/Get-AzStorageMover.md b/src/StorageMover/StorageMover.Autorest/help/Get-AzStorageMover.md new file mode 100644 index 000000000000..853ba4d09b28 --- /dev/null +++ b/src/StorageMover/StorageMover.Autorest/help/Get-AzStorageMover.md @@ -0,0 +1,231 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/get-azstoragemover +schema: 2.0.0 +--- + +# Get-AzStorageMover + +## SYNOPSIS +Gets a Storage Mover resource. + +## SYNTAX + +### List (Default) +``` +Get-AzStorageMover [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzStorageMover -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzStorageMover -InputObject [-DefaultProfile ] [] +``` + +### List1 +``` +Get-AzStorageMover -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Gets a Storage Mover resource. + +## EXAMPLES + +### Example 1: Get all Storage movers in a subcription +```powershell + Get-AzStorageMover +``` + +```output +Description : StorageMover description +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover1 +Location : eastus +Name : myStorageMover1 +ProvisioningState : Succeeded +SystemDataCreatedAt : 8/2/2022 5:35:00 AM +SystemDataCreatedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 8/2/2022 5:35:00 AM +SystemDataLastModifiedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataLastModifiedByType : Application +Tag : { + "tag2": "value2", + "tag1": "value1" + } +Type : microsoft.storagemover/storagemovers + +Description : StorageMover description +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup2/providers/Microsoft.StorageMover/storageMovers/myStorageMover2 +Location : eastus +Name : myStorageMover2 +ProvisioningState : Succeeded +SystemDataCreatedAt : 8/2/2022 5:35:00 AM +SystemDataCreatedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 8/2/2022 5:35:00 AM +SystemDataLastModifiedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataLastModifiedByType : Application +Tag : { + "tag2": "value2", + "tag1": "value1" + } +Type : microsoft.storagemover/storagemovers +``` + +This command gets all the Storage movers in a subscription. + +### Example 2: Get all Storage movers in a resource group +```powershell +Get-AzStorageMover -ResourceGroupName myResourceGroup +``` + +```output +Description : StorageMover description +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover1 +Location : eastus +Name : myStorageMover1 +ProvisioningState : Succeeded +SystemDataCreatedAt : 8/2/2022 5:35:00 AM +SystemDataCreatedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 8/2/2022 5:35:00 AM +SystemDataLastModifiedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataLastModifiedByType : Application +Tag : { + "tag2": "value2", + "tag1": "value1" + } +Type : microsoft.storagemover/storagemovers +``` + +This command gets all the Storage movers in a resource group. + +### Example 2: Get a specific Storage mover +```powershell +Get-AzStorageMover -ResourceGroupName myResourceGroup -Name myStorageMover1 +``` + +```output +Description : StorageMover description +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover1 +Location : eastus +Name : myStorageMover1 +ProvisioningState : Succeeded +SystemDataCreatedAt : 8/2/2022 5:35:00 AM +SystemDataCreatedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 8/2/2022 5:35:00 AM +SystemDataLastModifiedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataLastModifiedByType : Application +Tag : { + "tag2": "value2", + "tag1": "value1" + } +Type : microsoft.storagemover/storagemovers +``` + +This command gets a specific Storage mover. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: StorageMoverName + +Required: True +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: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IStorageMover + +## NOTES + +## RELATED LINKS + diff --git a/src/StorageMover/StorageMover.Autorest/help/Get-AzStorageMoverAgent.md b/src/StorageMover/StorageMover.Autorest/help/Get-AzStorageMoverAgent.md new file mode 100644 index 000000000000..7e7e22dc2908 --- /dev/null +++ b/src/StorageMover/StorageMover.Autorest/help/Get-AzStorageMoverAgent.md @@ -0,0 +1,210 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/get-azstoragemoveragent +schema: 2.0.0 +--- + +# Get-AzStorageMoverAgent + +## SYNOPSIS +Gets an Agent resource. + +## SYNTAX + +### List (Default) +``` +Get-AzStorageMoverAgent -ResourceGroupName -StorageMoverName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzStorageMoverAgent -Name -ResourceGroupName -StorageMoverName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzStorageMoverAgent -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets an Agent resource. + +## EXAMPLES + +### Example 1: Get all agents in a Storage mover +```powershell +Get-AzStorageMoverAgent -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover +``` + +```output +AgentStatus : Registering +ArcResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myAgent +ArcVMUuid : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +Description : +ErrorDetailCode : +ErrorDetailMessage : +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/microsoft.storagemover/storagemovers/myStorageMover/agents/myAgent +LastStatusUpdate : +LocalIPAddress : +MemoryInMb : +Name : myAgent +NumberOfCores : +ProvisioningState : Succeeded +SystemDataCreatedAt : 8/2/2022 7:15:19 AM +SystemDataCreatedBy : myAccount@xxx.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 8/2/2022 7:15:19 AM +SystemDataLastModifiedBy : myAccount@xxx.com +SystemDataLastModifiedByType : User +Type : microsoft.storagemover/storagemovers/agents +UptimeInSeconds : +Version : +``` + +This command gets all the agents under a Storage mover + +### Example 2: Get a specific agent +```powershell +Get-AzStorageMoverAgent -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Name myAgent +``` + +```output +AgentStatus : Registering +ArcResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myAgent +ArcVMUuid : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +Description : +ErrorDetailCode : +ErrorDetailMessage : +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/microsoft.storagemover/storagemovers/myStorageMover/agents/myAgent +LastStatusUpdate : +LocalIPAddress : +MemoryInMb : +Name : myAgent +NumberOfCores : +ProvisioningState : Succeeded +SystemDataCreatedAt : 8/2/2022 7:15:19 AM +SystemDataCreatedBy : myAccount@xxx.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 8/2/2022 7:15:19 AM +SystemDataLastModifiedBy : myAccount@xxx.com +SystemDataLastModifiedByType : User +Type : microsoft.storagemover/storagemovers/agents +UptimeInSeconds : +Version : +``` + +This command gets a specific agent. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Agent resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: AgentName + +Required: True +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: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IAgent + +## NOTES + +## RELATED LINKS + diff --git a/src/StorageMover/StorageMover.Autorest/help/Get-AzStorageMoverEndpoint.md b/src/StorageMover/StorageMover.Autorest/help/Get-AzStorageMoverEndpoint.md new file mode 100644 index 000000000000..b24a4b493f38 --- /dev/null +++ b/src/StorageMover/StorageMover.Autorest/help/Get-AzStorageMoverEndpoint.md @@ -0,0 +1,213 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/get-azstoragemoverendpoint +schema: 2.0.0 +--- + +# Get-AzStorageMoverEndpoint + +## SYNOPSIS +Gets an Endpoint resource. + +## SYNTAX + +### List (Default) +``` +Get-AzStorageMoverEndpoint -ResourceGroupName -StorageMoverName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzStorageMoverEndpoint -Name -ResourceGroupName -StorageMoverName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzStorageMoverEndpoint -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Gets an Endpoint resource. + +## EXAMPLES + +### Example 1: Get all endpoints in a Storage mover +```powershell +Get-AzStorageMoverEndpoint -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover +``` + +```output +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/endpoints/myEndpoint1 +Name : myEndpoint1 +Property : { + "endpointType": "AzureStorageBlobContainer", + "provisioningState": "Succeeded", + "storageAccountResourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myStorageMover/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "blobContainerName": "myBlobContainer" + } +SystemDataCreatedAt : 7/18/2022 7:28:29 AM +SystemDataCreatedBy : xxxxxxxxxx +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 7/18/2022 7:28:29 AM +SystemDataLastModifiedBy : xxxxxxxxxxx +SystemDataLastModifiedByType : User +Type : microsoft.storagemover/storagemovers/endpoints + +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/endpoints/myEndpoint2 +Name : myEndpoint2 +Property : { + "endpointType": "NfsMount", + "provisioningState": "Succeeded", + "host": "x.x.x.x", + "export": "/" + } +SystemDataCreatedAt : 7/18/2022 7:28:30 AM +SystemDataCreatedBy : xxxxxxx +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 7/18/2022 7:28:30 AM +SystemDataLastModifiedBy : xxxxxxx +SystemDataLastModifiedByType : User +Type : microsoft.storagemover/storagemovers/endpoints +``` + +This command gets all the endpoints under a Storage mover. + +### Example 2: Get a specific endpoint +```powershell +Get-AzStorageMoverEndpoint -ResourceGroupName myResourceGroupName -StorageMoverName myStorageMoverName -Name myEndpoint +``` + +```output +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/endpoints/myEndpoint +Name : myEndpoint +Property : { + "endpointType": "NfsMount", + "provisioningState": "Succeeded", + "host": "x.x.x.x", + "export": "/" + } +SystemDataCreatedAt : 7/18/2022 7:28:30 AM +SystemDataCreatedBy : xxxxxxx +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 7/18/2022 7:28:30 AM +SystemDataLastModifiedBy : xxxxxxx +SystemDataLastModifiedByType : User +Type : microsoft.storagemover/storagemovers/endpoints +``` + +This command gets a specific endpoint under a Storage mover. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Endpoint resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: EndpointName + +Required: True +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: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IEndpoint + +## NOTES + +## RELATED LINKS + diff --git a/src/StorageMover/StorageMover.Autorest/help/Get-AzStorageMoverJobDefinition.md b/src/StorageMover/StorageMover.Autorest/help/Get-AzStorageMoverJobDefinition.md new file mode 100644 index 000000000000..2974721bdf73 --- /dev/null +++ b/src/StorageMover/StorageMover.Autorest/help/Get-AzStorageMoverJobDefinition.md @@ -0,0 +1,228 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/get-azstoragemoverjobdefinition +schema: 2.0.0 +--- + +# Get-AzStorageMoverJobDefinition + +## SYNOPSIS +Gets a Job Definition resource. + +## SYNTAX + +### List (Default) +``` +Get-AzStorageMoverJobDefinition -ProjectName -ResourceGroupName -StorageMoverName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzStorageMoverJobDefinition -Name -ProjectName -ResourceGroupName + -StorageMoverName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzStorageMoverJobDefinition -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Gets a Job Definition resource. + +## EXAMPLES + +### Example 1: Get all job definitions under a Storage mover +```powershell +Get-AzStorageMoverJobDefinition -ProjectName myProject -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover +``` + +```output +AgentName : myAgent +AgentResourceId : +CopyMode : Additive +Description : +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/projects/myProject/jobDefinitions/myJob1 +LatestJobRunName : 12345678-1234-1234-1234-111111111111 +LatestJobRunResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/projects/myProject/jobDefinitions/myJob1/jobRuns/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +LatestJobRunStatus : Queued +Name : myJob1 +ProvisioningState : Succeeded +SourceName : nfsEndpoint1 +SourceResourceId : +SourceSubpath : +SystemDataCreatedAt : 7/28/2022 5:47:29 AM +SystemDataCreatedBy : bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 8/2/2022 3:09:15 AM +SystemDataLastModifiedBy : bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb +SystemDataLastModifiedByType : Application +TargetName : containerEndpoint1 +TargetResourceId : +TargetSubpath : +Type : microsoft.storagemover/storagemovers/projects/jobdefinitions +``` + +This command gets all the job definitions under a specific Storage mover. + +### Example 2: Get a specific job definition +```powershell +Get-AzStorageMoverJobDefinition -ProjectName myProject -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Name myJob1 +``` + +```output +AgentName : myAgent +AgentResourceId : +CopyMode : Additive +Description : +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/projects/myProject/jobDefinitions/myJob1 +LatestJobRunName : 12345678-1234-1234-1234-111111111111 +LatestJobRunResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/projects/myProject/jobDefinitions/myJob1/jobRuns/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +LatestJobRunStatus : Queued +Name : myJob1 +ProvisioningState : Succeeded +SourceName : nfsEndpoint1 +SourceResourceId : +SourceSubpath : +SystemDataCreatedAt : 7/28/2022 5:47:29 AM +SystemDataCreatedBy : bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 8/2/2022 3:09:15 AM +SystemDataLastModifiedBy : bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb +SystemDataLastModifiedByType : Application +TargetName : containerEndpoint1 +TargetResourceId : +TargetSubpath : +Type : microsoft.storagemover/storagemovers/projects/jobdefinitions +``` + +This command gets a specific job definition. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Job Definition resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: JobDefinitionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectName +The name of the Project resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +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: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IJobDefinition + +## NOTES + +## RELATED LINKS + diff --git a/src/StorageMover/StorageMover.Autorest/help/Get-AzStorageMoverJobRun.md b/src/StorageMover/StorageMover.Autorest/help/Get-AzStorageMoverJobRun.md new file mode 100644 index 000000000000..5d468c5689f9 --- /dev/null +++ b/src/StorageMover/StorageMover.Autorest/help/Get-AzStorageMoverJobRun.md @@ -0,0 +1,284 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/get-azstoragemoverjobrun +schema: 2.0.0 +--- + +# Get-AzStorageMoverJobRun + +## SYNOPSIS +Gets a Job Run resource. + +## SYNTAX + +### List (Default) +``` +Get-AzStorageMoverJobRun -JobDefinitionName -ProjectName -ResourceGroupName + -StorageMoverName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzStorageMoverJobRun -JobDefinitionName -Name -ProjectName + -ResourceGroupName -StorageMoverName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzStorageMoverJobRun -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Gets a Job Run resource. + +## EXAMPLES + +### Example 1: Get all job runs with a job definition +```powershell +Get-AzStorageMoverJobRun -JobDefinitionName myJobDefinition -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -ProjectName myProject +``` + +```output +AgentName : myAgent +AgentResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/agents/myAgent +BytesExcluded : 0 +BytesFailed : 0 +BytesNoTransferNeeded : 0 +BytesScanned : 0 +BytesTransferred : 0 +BytesUnsupported : 0 +ErrorCode : +ErrorMessage : +ExecutionEndTime : +ExecutionStartTime : 2/24/2023 12:27:58 AM +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/projects/myProject/jobDefinitions/myJob/ + jobRuns/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +ItemsExcluded : 0 +ItemsFailed : 0 +ItemsNoTransferNeeded : 0 +ItemsScanned : 0 +ItemsTransferred : 0 +ItemsUnsupported : 0 +JobDefinitionProperty : { + } +LastStatusUpdate : 2/24/2023 12:27:39 AM +Name : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +ProvisioningState : Succeeded +ScanStatus : NotStarted +SourceName : sourceendpoint +SourceProperty : { + } +SourceResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/endpoints/sourceendpoint +Status : Started +SystemDataCreatedAt : 2/24/2023 12:27:39 AM +SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 2/24/2023 12:36:01 AM +SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataLastModifiedByType : Application +Target : +TargetName : targetendpoint +TargetProperty : { + } +TargetResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/endpoints/targetendpoint +Type : microsoft.storagemover/storagemovers/projects/jobdefinitions/jobruns +``` + +This command gets all the job runs under a specific job definition + +### Example 2: Get a specific job run +```powershell +Get-AzStorageMoverJobRun -Name myJobRun -JobDefinitionName myJobDefinition -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -ProjectName myProject +``` + +```output +AgentName : myAgent +AgentResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/agents/myAgent +BytesExcluded : 0 +BytesFailed : 0 +BytesNoTransferNeeded : 0 +BytesScanned : 0 +BytesTransferred : 0 +BytesUnsupported : 0 +ErrorCode : +ErrorMessage : +ExecutionEndTime : +ExecutionStartTime : 2/24/2023 12:27:58 AM +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/projects/myProject/jobDefinitions/myJob/ + jobRuns/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +ItemsExcluded : 0 +ItemsFailed : 0 +ItemsNoTransferNeeded : 0 +ItemsScanned : 0 +ItemsTransferred : 0 +ItemsUnsupported : 0 +JobDefinitionProperty : { + } +LastStatusUpdate : 2/24/2023 12:27:39 AM +Name : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +ProvisioningState : Succeeded +ScanStatus : NotStarted +SourceName : sourceendpoint +SourceProperty : { + } +SourceResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/endpoints/sourceendpoint +Status : Started +SystemDataCreatedAt : 2/24/2023 12:27:39 AM +SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 2/24/2023 12:36:01 AM +SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +SystemDataLastModifiedByType : Application +Target : +TargetName : targetendpoint +TargetProperty : { + } +TargetResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/endpoints/targetendpoint +Type : microsoft.storagemover/storagemovers/projects/jobdefinitions/jobruns +``` + +This command gets a specific job run. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobDefinitionName +The name of the Job Definition resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Job Run resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: JobRunName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectName +The name of the Project resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +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: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IJobRun + +## NOTES + +## RELATED LINKS + diff --git a/src/StorageMover/StorageMover.Autorest/help/Get-AzStorageMoverProject.md b/src/StorageMover/StorageMover.Autorest/help/Get-AzStorageMoverProject.md new file mode 100644 index 000000000000..56c032067bd7 --- /dev/null +++ b/src/StorageMover/StorageMover.Autorest/help/Get-AzStorageMoverProject.md @@ -0,0 +1,201 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/get-azstoragemoverproject +schema: 2.0.0 +--- + +# Get-AzStorageMoverProject + +## SYNOPSIS +Gets a Project resource. + +## SYNTAX + +### List (Default) +``` +Get-AzStorageMoverProject -ResourceGroupName -StorageMoverName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzStorageMoverProject -Name -ResourceGroupName -StorageMoverName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzStorageMoverProject -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Gets a Project resource. + +## EXAMPLES + +### Example 1: Get all projects under a Storage mover +```powershell +$projectList = Get-AzStorageMoverProject -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover +``` + +```output +Description : My first project +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/projects/myProject1 +Name : myProject1 +ProvisioningState : Succeeded +SystemDataCreatedAt : 8/2/2022 5:23:49 AM +SystemDataCreatedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 8/2/2022 5:23:49 AM +SystemDataLastModifiedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataLastModifiedByType : Application +Type : microsoft.storagemover/storagemovers/projects + +Description : My second project +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/projects/myProject2 +Name : myProject2 +ProvisioningState : Succeeded +SystemDataCreatedAt : 8/2/2022 5:35:48 AM +SystemDataCreatedBy : bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 8/2/2022 5:35:48 AM +SystemDataLastModifiedBy : bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb +SystemDataLastModifiedByType : Application +Type : microsoft.storagemover/storagemovers/projects +``` + +This command gets all the projects under a Storage mover. + +### Example 2: Get a specific project +```powershell +$projectList = Get-AzStorageMoverProject -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Name myProject1 +``` + +```output +Description : My first project +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/projects/myProject1 +Name : myProject1 +ProvisioningState : Succeeded +SystemDataCreatedAt : 8/2/2022 5:23:49 AM +SystemDataCreatedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 8/2/2022 5:23:49 AM +SystemDataLastModifiedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataLastModifiedByType : Application +Type : microsoft.storagemover/storagemovers/projects +``` + +This command gets a specific project under a Storage mover. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Project resource. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ProjectName + +Required: True +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: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IProject + +## NOTES + +## RELATED LINKS + diff --git a/src/StorageMover/StorageMover.Autorest/help/New-AzStorageMover.md b/src/StorageMover/StorageMover.Autorest/help/New-AzStorageMover.md new file mode 100644 index 000000000000..b3159748e7d4 --- /dev/null +++ b/src/StorageMover/StorageMover.Autorest/help/New-AzStorageMover.md @@ -0,0 +1,228 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemover +schema: 2.0.0 +--- + +# New-AzStorageMover + +## SYNOPSIS +Creates or updates a top-level Storage Mover resource. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzStorageMover -Name -ResourceGroupName -Location [-SubscriptionId ] + [-Description ] [-Tag ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### Create +``` +New-AzStorageMover -Name -ResourceGroupName -StorageMover + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates or updates a top-level Storage Mover resource. + +## EXAMPLES + +### Example 1: Create a Storage mover +```powershell +New-AzStorageMover -ResourceGroupName myResourceGroup -Name myStorageMover -Location eastus -Description "Description" +``` + +```output +Description : +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storage + Movers/myStorageMover +Location : eastus +Name : myStorageMover +ProvisioningState : Succeeded +SystemDataCreatedAt : 7/26/2022 5:49:02 AM +SystemDataCreatedBy : xxxxxxxxxx +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 7/26/2022 5:49:02 AM +SystemDataLastModifiedBy : xxxxxxxxxx +SystemDataLastModifiedByType : User +Tag : { + } +Type : microsoft.storagemover/storagemovers +``` + +This command creates a Storage mover for a resource group. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description for the Storage Mover. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: StorageMoverName + +Required: True +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: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMover +The Storage Mover resource, which is a container for a group of Agents, Projects, and Endpoints. +To construct, see NOTES section for STORAGEMOVER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IStorageMover +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IStorageMover + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IStorageMover + +## NOTES + +## RELATED LINKS + diff --git a/src/StorageMover/StorageMover/help/New-AzStorageMoverSmbFileShareEndpoint.md b/src/StorageMover/StorageMover.Autorest/help/New-AzStorageMoverAzSmbFileShareEndpoint.md similarity index 90% rename from src/StorageMover/StorageMover/help/New-AzStorageMoverSmbFileShareEndpoint.md rename to src/StorageMover/StorageMover.Autorest/help/New-AzStorageMoverAzSmbFileShareEndpoint.md index b07651abcd4b..0ad56f825dfe 100644 --- a/src/StorageMover/StorageMover/help/New-AzStorageMoverSmbFileShareEndpoint.md +++ b/src/StorageMover/StorageMover.Autorest/help/New-AzStorageMoverAzSmbFileShareEndpoint.md @@ -1,11 +1,11 @@ --- external help file: Module Name: Az.StorageMover -online version: https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemoversmbfileshareendpoint +online version: https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemoverazsmbfileshareendpoint schema: 2.0.0 --- -# New-AzStorageMoverSmbFileShareEndpoint +# New-AzStorageMoverAzSmbFileShareEndpoint ## SYNOPSIS Creates a Smb file share endpoint resource, which represents a data transfer source or destination. @@ -13,7 +13,7 @@ Creates a Smb file share endpoint resource, which represents a data transfer sou ## SYNTAX ``` -New-AzStorageMoverSmbFileShareEndpoint -Name -ResourceGroupName -StorageMoverName +New-AzStorageMoverAzSmbFileShareEndpoint -Name -ResourceGroupName -StorageMoverName -FileShareName -StorageAccountResourceId [-SubscriptionId ] [-Description ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] ``` @@ -25,7 +25,7 @@ Creates a Smb file share endpoint resource, which represents a data transfer sou ### Example 1: Create an Smb file share endpoint ```powershell -New-AzStorageMoverSmbFileShareEndpoint -Name "myendpoint" -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -StorageAccountResourceId $accountresourceid -FileShareName testfs -Description "New smb file share endpoint" +New-AzStorageMoverAzSmbFileShareEndpoint -Name "myendpoint" -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -StorageAccountResourceId $accountresourceid -FileShareName testfs -Description "New smb file share endpoint" ``` ```output @@ -47,7 +47,7 @@ SystemDataLastModifiedByType : Application Type : microsoft.storagemover/storagemovers/endpoints ``` -This command creats a Smb file share endpoint +This command creats an Azure Storage SMB file share endpoint. ## PARAMETERS @@ -218,5 +218,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES +ALIASES + +New-AzStorageMoverSmbFileShareEndpoint + ## RELATED LINKS diff --git a/src/StorageMover/StorageMover.Autorest/help/New-AzStorageMoverAzStorageContainerEndpoint.md b/src/StorageMover/StorageMover.Autorest/help/New-AzStorageMoverAzStorageContainerEndpoint.md new file mode 100644 index 000000000000..597a28affc48 --- /dev/null +++ b/src/StorageMover/StorageMover.Autorest/help/New-AzStorageMoverAzStorageContainerEndpoint.md @@ -0,0 +1,222 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemoverazstoragecontainerendpoint +schema: 2.0.0 +--- + +# New-AzStorageMoverAzStorageContainerEndpoint + +## SYNOPSIS +Creates an AzStorageContainer endpoint resource, which represents a data transfer source or destination. + +## SYNTAX + +``` +New-AzStorageMoverAzStorageContainerEndpoint -Name -ResourceGroupName + -StorageMoverName -BlobContainerName -StorageAccountResourceId + [-SubscriptionId ] [-Description ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Creates an AzStorageContainer endpoint resource, which represents a data transfer source or destination. + +## EXAMPLES + +### Example 1: Create a AzStorageContainer endpoint +```powershell +New-AzStorageMoverAzStorageContainerEndpoint -Name myEndpoint -ResourceGroupName myResourceGroup -BlobContainerName myContainer -StorageMoverName myStorageMover -StorageAccountResourceId myAccountResourceId +``` + +```output +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/endpoints/myEndpoint +Name : myEndpoint +Property : { + "endpointType": "AzureStorageBlobContainer", + "provisioningState": "Succeeded", + "storageAccountResourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myStorageMover/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "blobContainerName": "myContainer" + } +SystemDataCreatedAt : 7/18/2022 7:28:29 AM +SystemDataCreatedBy : xxxxxxxxxx +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 7/18/2022 7:28:29 AM +SystemDataLastModifiedBy : xxxxxxxxxxx +SystemDataLastModifiedByType : User +Type : microsoft.storagemover/storagemovers/endpoints +``` + +This command creates a AzStorageContainer endpoint for a Storage mover. + +## PARAMETERS + +### -BlobContainerName +The name of the Storage blob container that is the target destination. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description for the endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the endpoint resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: EndpointName + +Required: True +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: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +The Azure Resource ID of the storage account that is the target destination. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 + diff --git a/src/StorageMover/StorageMover.Autorest/help/New-AzStorageMoverJobDefinition.md b/src/StorageMover/StorageMover.Autorest/help/New-AzStorageMoverJobDefinition.md new file mode 100644 index 000000000000..c15a11931b4a --- /dev/null +++ b/src/StorageMover/StorageMover.Autorest/help/New-AzStorageMoverJobDefinition.md @@ -0,0 +1,329 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemoverjobdefinition +schema: 2.0.0 +--- + +# New-AzStorageMoverJobDefinition + +## SYNOPSIS +Creates or updates a Job Definition resource, which contains configuration for a single unit of managed data transfer. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzStorageMoverJobDefinition -Name -ProjectName -ResourceGroupName + -StorageMoverName -CopyMode -SourceName -TargetName + [-SubscriptionId ] [-AgentName ] [-Description ] [-SourceSubpath ] + [-TargetSubpath ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### Create +``` +New-AzStorageMoverJobDefinition -Name -ProjectName -ResourceGroupName + -StorageMoverName -JobDefinition [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates or updates a Job Definition resource, which contains configuration for a single unit of managed data transfer. + +## EXAMPLES + +### Example 1: Create a job definition +```powershell +New-AzStorageMoverJobDefinition -Name myJob -ProjectName myProject -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -AgentName myAgent -SourceName myNfsEndpoint -TargetName myContainerEndpoint -CopyMode "Additive" -Description "job definition" +``` + +```output +AgentName : myAgent +AgentResourceId : +CopyMode : Additive +Description : job definition +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageM + overs/myStorageMover/projects/myProject/jobDefinitions/myJob +LatestJobRunName : +LatestJobRunResourceId : +LatestJobRunStatus : +Name : myJob +ProvisioningState : Succeeded +SourceName : myNfsEndpoint +SourceResourceId : +SourceSubpath : +SystemDataCreatedAt : 7/26/2022 6:14:43 AM +SystemDataCreatedBy : xxxxxxxxxxxxxxxxxxxx +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 7/26/2022 6:14:43 AM +SystemDataLastModifiedBy : xxxxxxxxxxxxxxxxxxxx +SystemDataLastModifiedByType : User +TargetName : myContainerEndpoint +TargetResourceId : +TargetSubpath : +Type : microsoft.storagemover/storagemovers/projects/jobdefinitions +``` + +This command creates a job definition. + +## PARAMETERS + +### -AgentName +Name of the Agent to assign for new Job Runs of this Job Definition. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CopyMode +Strategy to use for copy. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Support.CopyMode +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description for the Job Definition. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JobDefinition +The Job Definition resource. +To construct, see NOTES section for JOBDEFINITION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IJobDefinition +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Job Definition resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: JobDefinitionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectName +The name of the Project resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +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: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceName +The name of the source Endpoint. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceSubpath +The subpath to use when reading from the source Endpoint. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetName +The name of the target Endpoint. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetSubpath +The subpath to use when writing to the target Endpoint. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IJobDefinition + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IJobDefinition + +## NOTES + +## RELATED LINKS + diff --git a/src/StorageMover/StorageMover.Autorest/help/New-AzStorageMoverNfsEndpoint.md b/src/StorageMover/StorageMover.Autorest/help/New-AzStorageMoverNfsEndpoint.md new file mode 100644 index 000000000000..81836d3dec9a --- /dev/null +++ b/src/StorageMover/StorageMover.Autorest/help/New-AzStorageMoverNfsEndpoint.md @@ -0,0 +1,236 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemovernfsendpoint +schema: 2.0.0 +--- + +# New-AzStorageMoverNfsEndpoint + +## SYNOPSIS +Creates a Nfs endpoint resource, which represents a data transfer source or destination. + +## SYNTAX + +``` +New-AzStorageMoverNfsEndpoint -Name -ResourceGroupName -StorageMoverName + -Export -Host [-SubscriptionId ] [-Description ] [-NfsVersion ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates a Nfs endpoint resource, which represents a data transfer source or destination. + +## EXAMPLES + +### Example 1: Create a NFS endpoint +```powershell + New-AzStorageMoverNfsEndpoint -Name myEndpoint -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Host "10.0.0.1" -Export "/" -NfsVersion NFSv3 -Description "Description" +``` + +```output +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/endpoints/myEndpoint +Name : myEndpoint +Property : { + "endpointType": "NfsMount", + "provisioningState": "Succeeded", + "host": "10.0.0.1", + "export": "/" + } +SystemDataCreatedAt : 7/18/2022 7:28:30 AM +SystemDataCreatedBy : xxxxxxx +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 7/18/2022 7:28:30 AM +SystemDataLastModifiedBy : xxxxxxx +SystemDataLastModifiedByType : User +Type : microsoft.storagemover/storagemovers/endpoints +``` + +This command creates a NFS endpoint for a Storage mover. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description for the endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Export +The directory being exported from the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Host +The host name or IP address of the server exporting the file system. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the endpoint resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: EndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NfsVersion +The NFS protocol version. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Support.NfsVersion +Parameter Sets: (All) +Aliases: + +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: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 + diff --git a/src/StorageMover/StorageMover.Autorest/help/New-AzStorageMoverProject.md b/src/StorageMover/StorageMover.Autorest/help/New-AzStorageMoverProject.md new file mode 100644 index 000000000000..77bb729d3e3b --- /dev/null +++ b/src/StorageMover/StorageMover.Autorest/help/New-AzStorageMoverProject.md @@ -0,0 +1,211 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemoverproject +schema: 2.0.0 +--- + +# New-AzStorageMoverProject + +## SYNOPSIS +Creates or updates a Project resource, which is a logical grouping of related jobs. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzStorageMoverProject -Name -ResourceGroupName -StorageMoverName + [-SubscriptionId ] [-Description ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### Create +``` +New-AzStorageMoverProject -Name -ResourceGroupName -StorageMoverName + -Project [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Creates or updates a Project resource, which is a logical grouping of related jobs. + +## EXAMPLES + +### Example 1: Create a project +```powershell +New-AzStorageMoverProject -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Name myProject -Description "description" +``` + +```output +Description : description +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storage + Movers/myStorageMover/projects/myProject +Name : myProject +ProvisioningState : Succeeded +SystemDataCreatedAt : 7/26/2022 5:50:53 AM +SystemDataCreatedBy : xxxxxxxxxxxxxxxxxxxxxxxx +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 7/26/2022 5:50:53 AM +SystemDataLastModifiedBy : xxxxxxxxxxxxxxxxxxxxxxxx +SystemDataLastModifiedByType : User +Type : microsoft.storagemover/storagemovers/projects +``` + +This command creates a project for a Storage mover. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description for the Project. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the Project resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ProjectName + +Required: True +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. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IProject +Parameter Sets: Create +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IProject + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IProject + +## NOTES + +## RELATED LINKS + diff --git a/src/StorageMover/StorageMover.Autorest/help/New-AzStorageMoverSmbEndpoint.md b/src/StorageMover/StorageMover.Autorest/help/New-AzStorageMoverSmbEndpoint.md new file mode 100644 index 000000000000..3d256ac5a302 --- /dev/null +++ b/src/StorageMover/StorageMover.Autorest/help/New-AzStorageMoverSmbEndpoint.md @@ -0,0 +1,259 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemoversmbendpoint +schema: 2.0.0 +--- + +# New-AzStorageMoverSmbEndpoint + +## SYNOPSIS +Creates an SMB endpoint resource, which represents a data transfer source or destination. + +## SYNTAX + +``` +New-AzStorageMoverSmbEndpoint -Name -ResourceGroupName -StorageMoverName + -Host -ShareName [-SubscriptionId ] [-CredentialsPasswordUri ] + [-CredentialsUsernameUri ] [-Description ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Creates an SMB endpoint resource, which represents a data transfer source or destination. + +## EXAMPLES + +### Example 1: Create a SMB endpoint +```powershell +New-AzStorageMoverSmbEndpoint -Name "myendpoint" -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -Host "10.0.0.1" -ShareName "testshare" -CredentialsUsernameUri "https://examples-azureKeyVault.vault.azure.net/secrets/username1" -CredentialsPasswordUri "https://examples-azureKeyVault.vault.azure.net/secrets/password1" +``` + +```output +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.StorageMover/storageMovers/mystoragemover/endpoints/myendpoint +Name : myendpoint +Property : { + "endpointType": "SmbMount", + "provisioningState": "Succeeded", + "credentials": { + "type": "AzureKeyVaultSmb", + "usernameUri": "https://examples-azureKeyVault.vault.azure.net/secrets/username1", + "passwordUri": "https://examples-azureKeyVault.vault.azure.net/secrets/password1" + }, + "host": "10.0.0.1", + "shareName": "testshare" + } +SystemDataCreatedAt : 6/27/2023 4:30:50 AM +SystemDataCreatedBy : 00000000-0000-0000-0000-000000000000 +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 7/13/2023 8:19:34 AM +SystemDataLastModifiedBy : 00000000-0000-0000-0000-000000000000 +SystemDataLastModifiedByType : Application +Type : microsoft.storagemover/storagemovers/endpoints +``` + +This command creates a SMB endpoint for a Storage mover named "mystoragemover". + +## PARAMETERS + +### -CredentialsPasswordUri +The secret URI which stores the password. +Use empty string to clean-up existing value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialsUsernameUri +The secret URI which stores the username. +Use empty string to clean-up existing value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description for the endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Host +The host name or IP address of the server exporting the file system. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the endpoint resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: EndpointName + +Required: True +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: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShareName +The name of the SMB share being exported from the server + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 + diff --git a/src/StorageMover/StorageMover.Autorest/help/README.md b/src/StorageMover/StorageMover.Autorest/help/README.md new file mode 100644 index 000000000000..347a65ee349e --- /dev/null +++ b/src/StorageMover/StorageMover.Autorest/help/README.md @@ -0,0 +1,11 @@ +# Docs +This directory contains the documentation of the cmdlets for the `Az.StorageMover` module. To run documentation generation, use the `generate-help.ps1` script at the root module folder. Files in this folder will *always be overridden on regeneration*. To update documentation examples, please use the `..\examples` folder. + +## Info +- Modifiable: no +- Generated: all +- Committed: yes +- Packaged: yes + +## Details +The process of documentation generation loads `Az.StorageMover` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) that are generated into the scripts in the `..\exports` folder. Additionally, when writing custom cmdlets in the `..\custom` folder, you can use the help comments syntax, which decorate the exported scripts at build-time. The documentation examples are taken from the `..\examples` folder. \ No newline at end of file diff --git a/src/StorageMover/StorageMover.Autorest/help/Remove-AzStorageMover.md b/src/StorageMover/StorageMover.Autorest/help/Remove-AzStorageMover.md new file mode 100644 index 000000000000..c9fde436a739 --- /dev/null +++ b/src/StorageMover/StorageMover.Autorest/help/Remove-AzStorageMover.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/remove-azstoragemover +schema: 2.0.0 +--- + +# Remove-AzStorageMover + +## SYNOPSIS +Deletes a Storage Mover resource. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzStorageMover -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-Force] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-AzStorageMover -InputObject [-DefaultProfile ] [-AsJob] [-Force] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes a Storage Mover resource. + +## EXAMPLES + +### Example 1: Remove a Storage mover +```powershell +Remove-AzStorageMover -ResourceGroupName myResourceGroup -Name myStorageMover +``` + +This command removes a Storage mover. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: StorageMoverName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +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: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/StorageMover/StorageMover.Autorest/help/Remove-AzStorageMoverEndpoint.md b/src/StorageMover/StorageMover.Autorest/help/Remove-AzStorageMoverEndpoint.md new file mode 100644 index 000000000000..0cfccc20af17 --- /dev/null +++ b/src/StorageMover/StorageMover.Autorest/help/Remove-AzStorageMoverEndpoint.md @@ -0,0 +1,225 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/remove-azstoragemoverendpoint +schema: 2.0.0 +--- + +# Remove-AzStorageMoverEndpoint + +## SYNOPSIS +Deletes an Endpoint resource. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzStorageMoverEndpoint -Name -ResourceGroupName -StorageMoverName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-AzStorageMoverEndpoint -InputObject [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes an Endpoint resource. + +## EXAMPLES + +### Example 1: Remove an endpoint +```powershell +Remove-AzStorageMoverEndpoint -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Name myEndpoint +``` + +This command removes an endpoint from a Storage mover. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Endpoint resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: EndpointName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +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: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/StorageMover/StorageMover.Autorest/help/Remove-AzStorageMoverJobDefinition.md b/src/StorageMover/StorageMover.Autorest/help/Remove-AzStorageMoverJobDefinition.md new file mode 100644 index 000000000000..8e92f1776869 --- /dev/null +++ b/src/StorageMover/StorageMover.Autorest/help/Remove-AzStorageMoverJobDefinition.md @@ -0,0 +1,240 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/remove-azstoragemoverjobdefinition +schema: 2.0.0 +--- + +# Remove-AzStorageMoverJobDefinition + +## SYNOPSIS +Deletes a Job Definition resource. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzStorageMoverJobDefinition -Name -ProjectName -ResourceGroupName + -StorageMoverName [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzStorageMoverJobDefinition -InputObject [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes a Job Definition resource. + +## EXAMPLES + +### Example 1: Remove a job definition +```powershell +Remove-AzStorageMoverJobDefinition -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -ProjectName myProject -Name myJobDefinition +``` + +This command removes a job definition. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Job Definition resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: JobDefinitionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectName +The name of the Project resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +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: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/StorageMover/StorageMover.Autorest/help/Remove-AzStorageMoverProject.md b/src/StorageMover/StorageMover.Autorest/help/Remove-AzStorageMoverProject.md new file mode 100644 index 000000000000..06fef09dac97 --- /dev/null +++ b/src/StorageMover/StorageMover.Autorest/help/Remove-AzStorageMoverProject.md @@ -0,0 +1,225 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/remove-azstoragemoverproject +schema: 2.0.0 +--- + +# Remove-AzStorageMoverProject + +## SYNOPSIS +Deletes a Project resource. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzStorageMoverProject -Name -ResourceGroupName -StorageMoverName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-AzStorageMoverProject -InputObject [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes a Project resource. + +## EXAMPLES + +### Example 1: Remove a project +```powershell +Remove-AzStorageMoverProject -ResourceGroupName myResourceGroupName -StorageMoverName myStorageMover -Name myProject +``` + +This command removes a project. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Project resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ProjectName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +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: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/StorageMover/StorageMover.Autorest/help/Start-AzStorageMoverJobDefinition.md b/src/StorageMover/StorageMover.Autorest/help/Start-AzStorageMoverJobDefinition.md new file mode 100644 index 000000000000..e11228593968 --- /dev/null +++ b/src/StorageMover/StorageMover.Autorest/help/Start-AzStorageMoverJobDefinition.md @@ -0,0 +1,205 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/start-azstoragemoverjobdefinition +schema: 2.0.0 +--- + +# Start-AzStorageMoverJobDefinition + +## SYNOPSIS +Requests an Agent to start a new instance of this Job Definition, generating a new Job Run resource. + +## SYNTAX + +### Start (Default) +``` +Start-AzStorageMoverJobDefinition -JobDefinitionName -ProjectName + -ResourceGroupName -StorageMoverName [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### StartViaIdentity +``` +Start-AzStorageMoverJobDefinition -InputObject [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Requests an Agent to start a new instance of this Job Definition, generating a new Job Run resource. + +## EXAMPLES + +### Example 1: Start a job definition +```powershell +New-AzStorageMoverProject -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Name myProject -Description "description" + +New-AzStorageMoverAzStorageContainerEndpoint -Name myContainerEndpoint -ResourceGroupName myResourceGroup -BlobContainerName myContainer -StorageMoverName myStorageMover -StorageAccountResourceId myAccountResourceId +New-AzStorageMoverNfsEndpoint -Name myNfsEndpoint -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Host "x.x.x.x" -Export "/" -NfsVersion NFSv3 -Description "Description" + +New-AzStorageMoverJobDefinition -Name myJob -ProjectName myProject -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -AgentName myAgent -SourceName myNfsEndpoint -TargetName myContainerEndpoint -CopyMode Additive +Start-AzStorageMoverJobDefinition -JobDefinitionName myJobDefinition -ProjectName myProject -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover +``` + +```output +/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroupName/providers/Microsoft.StorageMover/storageMovers/myStorageMover/projects/myProject/jobDefinitions/myJobDefinition/jobRuns/yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy +``` + +This command starts a job definition. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: StartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobDefinitionName +The name of the Job Definition resource. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectName +The name of the Project resource. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +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: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + diff --git a/src/StorageMover/StorageMover.Autorest/help/Stop-AzStorageMoverJobDefinition.md b/src/StorageMover/StorageMover.Autorest/help/Stop-AzStorageMoverJobDefinition.md new file mode 100644 index 000000000000..32f41d7ac826 --- /dev/null +++ b/src/StorageMover/StorageMover.Autorest/help/Stop-AzStorageMoverJobDefinition.md @@ -0,0 +1,199 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/stop-azstoragemoverjobdefinition +schema: 2.0.0 +--- + +# Stop-AzStorageMoverJobDefinition + +## SYNOPSIS +Requests the Agent of any active instance of this Job Definition to stop. + +## SYNTAX + +### Stop (Default) +``` +Stop-AzStorageMoverJobDefinition -JobDefinitionName -ProjectName -ResourceGroupName + -StorageMoverName [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### StopViaIdentity +``` +Stop-AzStorageMoverJobDefinition -InputObject [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Requests the Agent of any active instance of this Job Definition to stop. + +## EXAMPLES + +### Example 1: Stop a job definition +```powershell +Stop-AzStorageMoverJobDefinition -JobDefinitionName myJobDefinition -ProjectName myProject -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover +``` + +```output +/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/projects/myProject/jobDefinitions/myJobDefinition/jobRuns/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +``` + +This command stops a job definition. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: StopViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobDefinitionName +The name of the Job Definition resource. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectName +The name of the Project resource. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +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: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + diff --git a/src/StorageMover/StorageMover.Autorest/help/Unregister-AzStorageMoverAgent.md b/src/StorageMover/StorageMover.Autorest/help/Unregister-AzStorageMoverAgent.md new file mode 100644 index 000000000000..336dac67d104 --- /dev/null +++ b/src/StorageMover/StorageMover.Autorest/help/Unregister-AzStorageMoverAgent.md @@ -0,0 +1,239 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/unregister-azstoragemoveragent +schema: 2.0.0 +--- + +# Unregister-AzStorageMoverAgent + +## SYNOPSIS +Deletes an agent resource. + +## SYNTAX + +### Delete (Default) +``` +Unregister-AzStorageMoverAgent -Name -ResourceGroupName -StorageMoverName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-Force] [-NoWait] [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Unregister-AzStorageMoverAgent -InputObject [-DefaultProfile ] [-AsJob] + [-Force] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes an agent resource. + +## EXAMPLES + +### Example 1: Unregister an agent +```powershell +Unregister-AzStorageMoverAgent -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Name myAgent +``` + +This command unresgisters an agent under a Storage mover. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the agent resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: AgentName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Returns true when the command succeeds + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +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: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/StorageMover/StorageMover.Autorest/help/Update-AzStorageMover.md b/src/StorageMover/StorageMover.Autorest/help/Update-AzStorageMover.md new file mode 100644 index 000000000000..7a1dfeb5f9ce --- /dev/null +++ b/src/StorageMover/StorageMover.Autorest/help/Update-AzStorageMover.md @@ -0,0 +1,244 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemover +schema: 2.0.0 +--- + +# Update-AzStorageMover + +## SYNOPSIS +Updates properties for a Storage Mover resource. +Properties not specified in the request body will be unchanged. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzStorageMover -Name -ResourceGroupName [-SubscriptionId ] + [-Description ] [-Tag ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### Update +``` +Update-AzStorageMover -Name -ResourceGroupName -StorageMover + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentity +``` +Update-AzStorageMover -InputObject -StorageMover + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzStorageMover -InputObject [-Description ] [-Tag ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Updates properties for a Storage Mover resource. +Properties not specified in the request body will be unchanged. + +## EXAMPLES + +### Example 1: Update a Storage mover +```powershell +Update-AzStorageMover -ResourceGroupName myResourceGroup -Name myStorageMover -Description "Update description" +``` + +```output +Description : Update description +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover +Location : eastus +Name : myStorageMover +ProvisioningState : Succeeded +SystemDataCreatedAt : 8/2/2022 3:32:45 AM +SystemDataCreatedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 8/3/2022 3:10:31 AM +SystemDataLastModifiedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataLastModifiedByType : Application +Tag : { + } +Type : microsoft.storagemover/storagemovers +``` + +This command updates the description of a Storage mover. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description for the Storage Mover. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: StorageMoverName + +Required: True +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: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMover +The Storage Mover resource. +To construct, see NOTES section for STORAGEMOVER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IStorageMoverUpdateParameters +Parameter Sets: Update, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IStorageMoverUpdateParameters + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IStorageMover + +## NOTES + +## RELATED LINKS + diff --git a/src/StorageMover/StorageMover.Autorest/help/Update-AzStorageMoverAgent.md b/src/StorageMover/StorageMover.Autorest/help/Update-AzStorageMoverAgent.md new file mode 100644 index 000000000000..67bccfb7ee1c --- /dev/null +++ b/src/StorageMover/StorageMover.Autorest/help/Update-AzStorageMoverAgent.md @@ -0,0 +1,251 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoveragent +schema: 2.0.0 +--- + +# Update-AzStorageMoverAgent + +## SYNOPSIS +Creates or updates an Agent resource. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzStorageMoverAgent -Name -ResourceGroupName -StorageMoverName + [-SubscriptionId ] [-Description ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### Update +``` +Update-AzStorageMoverAgent -Name -ResourceGroupName -StorageMoverName + -Agent [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaIdentity +``` +Update-AzStorageMoverAgent -InputObject -Agent + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzStorageMoverAgent -InputObject [-Description ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates or updates an Agent resource. + +## EXAMPLES + +### Example 1: Update an agent. +```powershell +Update-AzStorageMoverAgent -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Name myAgent -Description "Update description" +``` + +```output +AgentStatus : Registering +ArcResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myAgent +ArcVMUuid : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +Description : Update description +ErrorDetailCode : +ErrorDetailMessage : +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/microsoft.storagemover/storagemovers/myStorageMover/agents/myAgent +LastStatusUpdate : +LocalIPAddress : +MemoryInMb : +Name : myAgent +NumberOfCores : +ProvisioningState : Succeeded +SystemDataCreatedAt : 8/2/2022 7:15:19 AM +SystemDataCreatedBy : myAccount@xxx.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 8/2/2022 7:15:19 AM +SystemDataLastModifiedBy : myAccount@xxx.com +SystemDataLastModifiedByType : User +Type : microsoft.storagemover/storagemovers/agents +UptimeInSeconds : +Version : +``` + +This command updates the description of a Storage mover agent. + +## PARAMETERS + +### -Agent +The Agent resource. +To construct, see NOTES section for AGENT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IAgentUpdateParameters +Parameter Sets: Update, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description for the Agent. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Agent resource. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: AgentName + +Required: True +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: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IAgentUpdateParameters + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IAgent + +## NOTES + +## RELATED LINKS + diff --git a/src/StorageMover/StorageMover/help/Update-AzStorageMoverSmbFileShareEndpoint.md b/src/StorageMover/StorageMover.Autorest/help/Update-AzStorageMoverAzSmbFileShareEndpoint.md similarity index 89% rename from src/StorageMover/StorageMover/help/Update-AzStorageMoverSmbFileShareEndpoint.md rename to src/StorageMover/StorageMover.Autorest/help/Update-AzStorageMoverAzSmbFileShareEndpoint.md index 272c281d671b..5d3088a5b2e8 100644 --- a/src/StorageMover/StorageMover/help/Update-AzStorageMoverSmbFileShareEndpoint.md +++ b/src/StorageMover/StorageMover.Autorest/help/Update-AzStorageMoverAzSmbFileShareEndpoint.md @@ -1,11 +1,11 @@ --- external help file: Module Name: Az.StorageMover -online version: https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoversmbfileshareendpoint +online version: https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoverazsmbfileshareendpoint schema: 2.0.0 --- -# Update-AzStorageMoverSmbFileShareEndpoint +# Update-AzStorageMoverAzSmbFileShareEndpoint ## SYNOPSIS Updates properties for a SMB file share endpoint resource. @@ -15,14 +15,14 @@ Properties not specified in the request body will be unchanged. ### UpdateExpanded (Default) ``` -Update-AzStorageMoverSmbFileShareEndpoint -Name -ResourceGroupName +Update-AzStorageMoverAzSmbFileShareEndpoint -Name -ResourceGroupName -StorageMoverName [-SubscriptionId ] [-Description ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] ``` ### UpdateViaIdentityExpanded ``` -Update-AzStorageMoverSmbFileShareEndpoint -InputObject [-Description ] +Update-AzStorageMoverAzSmbFileShareEndpoint -InputObject [-Description ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] ``` @@ -34,7 +34,7 @@ Properties not specified in the request body will be unchanged. ### Example 1: Update a Smb file share endpoint ```powershell -Update-AzStorageMoverSmbFileShareEndpoint -Name "myendpoint" -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -Description "updated endpoint" +Update-AzStorageMoverAzSmbFileShareEndpoint -Name "myendpoint" -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -Description "updated endpoint" ``` ```output @@ -56,11 +56,11 @@ SystemDataLastModifiedByType : Application Type : microsoft.storagemover/storagemovers/endpoints ``` -This command updates a Smb file share enpdoint's description by manual inputs. +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-AzStorageMoverSmbFileShareEndpoint -Description "updated endpoint again" +Get-AzStorageMoverEndpoint -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -Name "myendpoint" | Update-AzStorageMoverAzSmbFileShareEndpoint -Description "updated endpoint again" ``` ```output @@ -82,7 +82,7 @@ SystemDataLastModifiedByType : Application Type : microsoft.storagemover/storagemovers/endpoints ``` -This command updates a Smb file share endpoint's description by pipeline +This command updates an Azure Storage SMB file share endpoint's description by pipeline. ## PARAMETERS @@ -237,5 +237,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES +ALIASES + +Update-AzStorageMoverSmbFileShareEndpoint + ## RELATED LINKS diff --git a/src/StorageMover/StorageMover.Autorest/help/Update-AzStorageMoverAzStorageContainerEndpoint.md b/src/StorageMover/StorageMover.Autorest/help/Update-AzStorageMoverAzStorageContainerEndpoint.md new file mode 100644 index 000000000000..8b7dae9399f6 --- /dev/null +++ b/src/StorageMover/StorageMover.Autorest/help/Update-AzStorageMoverAzStorageContainerEndpoint.md @@ -0,0 +1,215 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoverazstoragecontainerendpoint +schema: 2.0.0 +--- + +# Update-AzStorageMoverAzStorageContainerEndpoint + +## SYNOPSIS +Updates properties for an AzStorageContainer endpoint resource. +Properties not specified in the request body will be unchanged. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzStorageMoverAzStorageContainerEndpoint -Name -ResourceGroupName + -StorageMoverName [-SubscriptionId ] [-Description ] [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzStorageMoverAzStorageContainerEndpoint -InputObject [-Description ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Updates properties for an AzStorageContainer endpoint resource. +Properties not specified in the request body will be unchanged. + +## EXAMPLES + +### Example 1: Update an AzStorageContainer endpoint +```powershell +Update-AzStorageMoverAzStorageContainerEndpoint -Name myEndpoint -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Description "Update Description" +``` + +```output +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/endpoints/myEndpoint1 +Name : containerEndpointo3q8xlbr +Property : { + "endpointType": "AzureStorageBlobContainer", + "description": "Update Description", + "provisioningState": "Succeeded", + "storageAccountResourceId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myStorageMover/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "blobContainerName": "myContainer" + } +SystemDataCreatedAt : 7/18/2022 7:28:29 AM +SystemDataCreatedBy : xxxxxxxxxx +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 7/18/2022 7:28:29 AM +SystemDataLastModifiedBy : xxxxxxxxxxx +SystemDataLastModifiedByType : User +Type : microsoft.storagemover/storagemovers/endpoints +``` + +This command updates the description of an AzStorageContainerEndpoint. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description for the endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the endpoint resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: EndpointName + +Required: True +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: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IEndpoint + +## NOTES + +## RELATED LINKS + diff --git a/src/StorageMover/StorageMover.Autorest/help/Update-AzStorageMoverJobDefinition.md b/src/StorageMover/StorageMover.Autorest/help/Update-AzStorageMoverJobDefinition.md new file mode 100644 index 000000000000..fc41332c5ae8 --- /dev/null +++ b/src/StorageMover/StorageMover.Autorest/help/Update-AzStorageMoverJobDefinition.md @@ -0,0 +1,301 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoverjobdefinition +schema: 2.0.0 +--- + +# Update-AzStorageMoverJobDefinition + +## SYNOPSIS +Updates properties for a Job Definition resource. +Properties not specified in the request body will be unchanged. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzStorageMoverJobDefinition -Name -ProjectName -ResourceGroupName + -StorageMoverName [-SubscriptionId ] [-AgentName ] [-CopyMode ] + [-Description ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### Update +``` +Update-AzStorageMoverJobDefinition -Name -ProjectName -ResourceGroupName + -StorageMoverName -JobDefinition [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentity +``` +Update-AzStorageMoverJobDefinition -InputObject + -JobDefinition [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzStorageMoverJobDefinition -InputObject [-AgentName ] + [-CopyMode ] [-Description ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Updates properties for a Job Definition resource. +Properties not specified in the request body will be unchanged. + +## EXAMPLES + +### Example 1: Update a job definition +```powershell +Update-AzStorageMoverJobDefinition -Name myJob -ProjectName myProject -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Description "Update Description" +``` + +```output +AgentName : myAgent +AgentResourceId : +CopyMode : Additive +Description : Update description +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/projects/myProject/jobDefinitions/myJob +LatestJobRunName : 12345678-1234-1234-1234-111111111111 +LatestJobRunResourceId : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/projects/myProject/jobDefinitions/myJob/jobRuns/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +LatestJobRunStatus : Queued +Name : myJob +ProvisioningState : Succeeded +SourceName : nfsEndpoint1 +SourceResourceId : +SourceSubpath : +SystemDataCreatedAt : 7/28/2022 5:47:29 AM +SystemDataCreatedBy : bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 8/2/2022 3:09:15 AM +SystemDataLastModifiedBy : bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb +SystemDataLastModifiedByType : Application +TargetName : containerEndpoint1 +TargetResourceId : +TargetSubpath : +Type : microsoft.storagemover/storagemovers/projects/jobdefinitions +``` + +This command updates the description of a job definition. + +## PARAMETERS + +### -AgentName +Name of the Agent to assign for new Job Runs of this Job Definition. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CopyMode +Strategy to use for copy. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Support.CopyMode +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description for the Job Definition. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JobDefinition +The Job Definition resource. +To construct, see NOTES section for JOBDEFINITION properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IJobDefinitionUpdateParameters +Parameter Sets: Update, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Job Definition resource. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: JobDefinitionName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProjectName +The name of the Project resource. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +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: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IJobDefinitionUpdateParameters + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IJobDefinition + +## NOTES + +## RELATED LINKS + diff --git a/src/StorageMover/StorageMover.Autorest/help/Update-AzStorageMoverNfsEndpoint.md b/src/StorageMover/StorageMover.Autorest/help/Update-AzStorageMoverNfsEndpoint.md new file mode 100644 index 000000000000..6e4d985c71fe --- /dev/null +++ b/src/StorageMover/StorageMover.Autorest/help/Update-AzStorageMoverNfsEndpoint.md @@ -0,0 +1,215 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemovernfsendpoint +schema: 2.0.0 +--- + +# Update-AzStorageMoverNfsEndpoint + +## SYNOPSIS +Updates properties for a Nfs endpoint resource. +Properties not specified in the request body will be unchanged. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzStorageMoverNfsEndpoint -Name -ResourceGroupName -StorageMoverName + [-SubscriptionId ] [-Description ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzStorageMoverNfsEndpoint -InputObject [-Description ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Updates properties for a Nfs endpoint resource. +Properties not specified in the request body will be unchanged. + +## EXAMPLES + +### Example 1: Update a NFS endpoint +```powershell +Update-AzStorageMoverNfsEndpoint -Name myEndpoint -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Description "Update Description" +``` + +```output +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/endpoints/myEndpoint +Name : myEndpoint +Property : { + "endpointType": "NfsMount", + "description": "Update Description" + "provisioningState": "Succeeded", + "host": "10.0.0.1", + "export": "/" + } +SystemDataCreatedAt : 7/18/2022 7:28:30 AM +SystemDataCreatedBy : xxxxxxx +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 7/18/2022 7:28:30 AM +SystemDataLastModifiedBy : xxxxxxx +SystemDataLastModifiedByType : User +Type : microsoft.storagemover/storagemovers/endpoints +``` + +This command updates the description of a NFS endpoint. + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description for the endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the endpoint resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: EndpointName + +Required: True +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: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IEndpoint + +## NOTES + +## RELATED LINKS + diff --git a/src/StorageMover/StorageMover.Autorest/help/Update-AzStorageMoverProject.md b/src/StorageMover/StorageMover.Autorest/help/Update-AzStorageMoverProject.md new file mode 100644 index 000000000000..e71f63b0655e --- /dev/null +++ b/src/StorageMover/StorageMover.Autorest/help/Update-AzStorageMoverProject.md @@ -0,0 +1,242 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoverproject +schema: 2.0.0 +--- + +# Update-AzStorageMoverProject + +## SYNOPSIS +Updates properties for a Project resource. +Properties not specified in the request body will be unchanged. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzStorageMoverProject -Name -ResourceGroupName -StorageMoverName + [-SubscriptionId ] [-Description ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### Update +``` +Update-AzStorageMoverProject -Name -ResourceGroupName -StorageMoverName + -Project [-SubscriptionId ] [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaIdentity +``` +Update-AzStorageMoverProject -InputObject -Project + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzStorageMoverProject -InputObject [-Description ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Updates properties for a Project resource. +Properties not specified in the request body will be unchanged. + +## EXAMPLES + +### Example 1: Update a project +```powershell +Update-AzStorageMoverProject -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Name myProject -Description "Update Description" +``` + +```output +Description : Update description +Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.StorageMover/storageMovers/myStorageMover/projects/myProject +Name : myProject +ProvisioningState : Succeeded +SystemDataCreatedAt : 8/2/2022 5:23:49 AM +SystemDataCreatedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 8/2/2022 5:23:49 AM +SystemDataLastModifiedBy : aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa +SystemDataLastModifiedByType : Application +Type : microsoft.storagemover/storagemovers/projects +``` + +This command updates the description of a project. + +## PARAMETERS + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description for the Project. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the Project resource. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: ProjectName + +Required: True +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. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IProjectUpdateParameters +Parameter Sets: Update, UpdateViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Update, UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IProjectUpdateParameters + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IProject + +## NOTES + +## RELATED LINKS + diff --git a/src/StorageMover/StorageMover.Autorest/help/Update-AzStorageMoverSmbEndpoint.md b/src/StorageMover/StorageMover.Autorest/help/Update-AzStorageMoverSmbEndpoint.md new file mode 100644 index 000000000000..4655025fb0b7 --- /dev/null +++ b/src/StorageMover/StorageMover.Autorest/help/Update-AzStorageMoverSmbEndpoint.md @@ -0,0 +1,284 @@ +--- +external help file: +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoversmbendpoint +schema: 2.0.0 +--- + +# Update-AzStorageMoverSmbEndpoint + +## SYNOPSIS +Updates properties for a SMB endpoint resource. +Properties not specified in the request body will be unchanged. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzStorageMoverSmbEndpoint -Name -ResourceGroupName -StorageMoverName + [-SubscriptionId ] [-CredentialsPasswordUri ] [-CredentialsUsernameUri ] + [-Description ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzStorageMoverSmbEndpoint -InputObject [-CredentialsPasswordUri ] + [-CredentialsUsernameUri ] [-Description ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Updates properties for a SMB endpoint resource. +Properties not specified in the request body will be unchanged. + +## EXAMPLES + +### Example 1: Update a SMB endpoint +```powershell +Update-AzStorageMoverSmbEndpoint -Name "myendpoint" -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -CredentialsUsernameUri "https://examples-azureKeyVault.vault.azure.net/secrets/username2" -CredentialsPasswordUri "https://examples-azureKeyVault.vault.azure.net/secrets/password2" -Description "update endpoint" +``` + +```output +Id : /subscriptions/00000000-0000-0000-0000-000000000000e/resourceGroups/myresourcegroup/providers/Microsoft.StorageMover/storageMovers/mystoragemover/endpoints/myendpoint +Name : myendpoint +Property : { + "endpointType": "SmbMount", + "description": "update endpoint", + "provisioningState": "Succeeded", + "credentials": { + "type": "AzureKeyVaultSmb", + "usernameUri": "https://examples-azureKeyVault.vault.azure.net/secrets/username2", + "passwordUri": "https://examples-azureKeyVault.vault.azure.net/secrets/password2" + }, + "host": "10.0.0.1", + "shareName": "testshare" + } +SystemDataCreatedAt : 6/27/2023 4:30:50 AM +SystemDataCreatedBy : 00000000-0000-0000-0000-000000000000 +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 7/13/2023 8:26:34 AM +SystemDataLastModifiedBy : 00000000-0000-0000-0000-000000000000 +SystemDataLastModifiedByType : Application +Type : microsoft.storagemover/storagemovers/endpoints +``` + +This command updates the description, credential username, and credential password of a SMB endpoint by manual inputs. + +### Example 2: Update a SMB endpoint by pipeline +```powershell +Get-AzStorageMoverEndpoint -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -Name "myendpoint" | Update-AzStorageMoverSmbEndpoint -CredentialsPasswordUri "" -CredentialsUsernameUri "" -Description "update endpoint again" +``` + +```output +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegorup/providers/Microsoft.StorageMover/storageMovers/mystoragemover/endpoints/myendpoint +Name : myendpoint +Property : { + "endpointType": "SmbMount", + "description": "update endpoint again", + "provisioningState": "Succeeded", + "credentials": { + "type": "AzureKeyVaultSmb", + "usernameUri": "", + "passwordUri": "" + }, + "host": "10.0.0.1", + "shareName": "testshare" + } +SystemDataCreatedAt : 6/27/2023 4:30:50 AM +SystemDataCreatedBy : 00000000-0000-0000-0000-000000000000 +SystemDataCreatedByType : Application +SystemDataLastModifiedAt : 7/13/2023 8:29:10 AM +SystemDataLastModifiedBy : 00000000-0000-0000-0000-000000000000 +SystemDataLastModifiedByType : Application +Type : microsoft.storagemover/storagemovers/endpoints +``` + +This command updates the description and clears the credential username and password of a SMB endpoint by pipeline. + +## PARAMETERS + +### -CredentialsPasswordUri +The secret URI which stores the password. +Use empty string to clean-up existing value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CredentialsUsernameUri +The secret URI which stores the username. +Use empty string to clean-up existing value. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description for the endpoint. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the endpoint resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: EndpointName + +Required: True +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: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.Api20231001.IEndpoint + +## NOTES + +## RELATED LINKS + diff --git a/src/StorageMover/StorageMover.Autorest/test/New-AzStorageMoverAzSmbFileShareEndpoint.Recording.json b/src/StorageMover/StorageMover.Autorest/test/New-AzStorageMoverAzSmbFileShareEndpoint.Recording.json new file mode 100644 index 000000000000..57a927ffb364 --- /dev/null +++ b/src/StorageMover/StorageMover.Autorest/test/New-AzStorageMoverAzSmbFileShareEndpoint.Recording.json @@ -0,0 +1,322 @@ +{ + "New/Update-AzStorageMoverAzSmbFileShareEndpoint+[NoContext]+Create and update+$PUT+https://management.azure.com/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint1hc715gxy?api-version=2023-10-01+1": { + "Request": { + "Method": "PUT", + "RequestUri": "https://management.azure.com/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint1hc715gxy?api-version=2023-10-01", + "Content": "{\r\n \"properties\": {\r\n \"endpointType\": \"AzureStorageSmbFileShare\",\r\n \"description\": \"New smb file share endpoint\",\r\n \"storageAccountResourceId\": \"/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.Storage/storageAccounts/storacchc715gxy\",\r\n \"fileShareName\": \"testfs\"\r\n }\r\n}", + "isContentBase64": false, + "Headers": { + }, + "ContentHeaders": { + "Content-Type": [ "application/json" ], + "Content-Length": [ "339" ] + } + }, + "Response": { + "StatusCode": 200, + "Headers": { + "Cache-Control": [ "no-cache" ], + "Pragma": [ "no-cache" ], + "ETag": [ "\"2d011c48-0000-3400-0000-64ba09a10000\"" ], + "x-ms-ratelimit-remaining-subscription-writes": [ "1191" ], + "x-ms-providerhub-traffic": [ "True" ], + "mise-correlation-id": [ "e2ca2827-3c7e-4a2e-808e-13d705e41049" ], + "x-ms-request-id": [ "e186296f-e455-44e8-9af2-5c510c5aaf96" ], + "x-ms-correlation-request-id": [ "fed03c95-e2aa-49e8-b6ee-816a857127d7" ], + "x-ms-routing-request-id": [ "EASTUS2EUAP:20230721T042921Z:fed03c95-e2aa-49e8-b6ee-816a857127d7" ], + "Strict-Transport-Security": [ "max-age=31536000; includeSubDomains" ], + "X-Content-Type-Options": [ "nosniff" ], + "Date": [ "Fri, 21 Jul 2023 04:29:21 GMT" ] + }, + "ContentHeaders": { + "Content-Length": [ "887" ], + "Content-Type": [ "application/json; charset=utf-8" ], + "Expires": [ "-1" ] + }, + "Content": "{\"id\":\"/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint1hc715gxy\",\"name\":\"fseendpoint1hc715gxy\",\"type\":\"microsoft.storagemover/storagemovers/endpoints\",\"systemData\":{\"createdBy\":\"a000255f-5f09-45e0-a970-9d9ed9cc6453\",\"createdByType\":\"Application\",\"createdAt\":\"2023-07-21T04:29:21.5382807Z\",\"lastModifiedBy\":\"a000255f-5f09-45e0-a970-9d9ed9cc6453\",\"lastModifiedByType\":\"Application\",\"lastModifiedAt\":\"2023-07-21T04:29:21.5382807Z\"},\"properties\":{\"storageAccountResourceId\":\"/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.Storage/storageAccounts/storacchc715gxy\",\"fileShareName\":\"testfs\",\"endpointType\":\"AzureStorageSmbFileShare\",\"description\":\"New smb file share endpoint\",\"provisioningState\":\"Succeeded\"}}", + "isContentBase64": false + } + }, + "New/Update-AzStorageMoverAzSmbFileShareEndpoint+[NoContext]+Create and update+$PUT+https://management.azure.com/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint2hc715gxy?api-version=2023-10-01+2": { + "Request": { + "Method": "PUT", + "RequestUri": "https://management.azure.com/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover2hc715gxy/endpoints/fseendpoint2hc715gxy?api-version=2023-10-01", + "Content": "{\r\n \"properties\": {\r\n \"endpointType\": \"AzureStorageSmbFileShare\",\r\n \"description\": \"New smb file share endpoint\",\r\n \"storageAccountResourceId\": \"/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.Storage/storageAccounts/storacchc715gxy\",\r\n \"fileShareName\": \"testfs\"\r\n }\r\n}", + "isContentBase64": false, + "Headers": { + }, + "ContentHeaders": { + "Content-Type": [ "application/json" ], + "Content-Length": [ "339" ] + } + }, + "Response": { + "StatusCode": 200, + "Headers": { + "Cache-Control": [ "no-cache" ], + "Pragma": [ "no-cache" ], + "ETag": [ "\"2d011c48-0000-3400-0000-64ba09a10000\"" ], + "x-ms-ratelimit-remaining-subscription-writes": [ "1191" ], + "x-ms-providerhub-traffic": [ "True" ], + "mise-correlation-id": [ "e2ca2827-3c7e-4a2e-808e-13d705e41049" ], + "x-ms-request-id": [ "e186296f-e455-44e8-9af2-5c510c5aaf96" ], + "x-ms-correlation-request-id": [ "fed03c95-e2aa-49e8-b6ee-816a857127d7" ], + "x-ms-routing-request-id": [ "EASTUS2EUAP:20230721T042921Z:fed03c95-e2aa-49e8-b6ee-816a857127d7" ], + "Strict-Transport-Security": [ "max-age=31536000; includeSubDomains" ], + "X-Content-Type-Options": [ "nosniff" ], + "Date": [ "Fri, 21 Jul 2023 04:29:21 GMT" ] + }, + "ContentHeaders": { + "Content-Length": [ "887" ], + "Content-Type": [ "application/json; charset=utf-8" ], + "Expires": [ "-1" ] + }, + "Content": "{\"id\":\"/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint2hc715gxy\",\"name\":\"fseendpoint2hc715gxy\",\"type\":\"microsoft.storagemover/storagemovers/endpoints\",\"systemData\":{\"createdBy\":\"a000255f-5f09-45e0-a970-9d9ed9cc6453\",\"createdByType\":\"Application\",\"createdAt\":\"2023-07-21T04:29:21.5382807Z\",\"lastModifiedBy\":\"a000255f-5f09-45e0-a970-9d9ed9cc6453\",\"lastModifiedByType\":\"Application\",\"lastModifiedAt\":\"2023-07-21T04:29:21.5382807Z\"},\"properties\":{\"storageAccountResourceId\":\"/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.Storage/storageAccounts/storacchc715gxy\",\"fileShareName\":\"testfs\",\"endpointType\":\"AzureStorageSmbFileShare\",\"description\":\"New smb file share endpoint\",\"provisioningState\":\"Succeeded\"}}", + "isContentBase64": false + } + }, + "New/Update-AzStorageMoverAzSmbFileShareEndpoint+[NoContext]+Create and update+$GET+https://management.azure.com/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint1hc715gxy?api-version=2023-10-01+3": { + "Request": { + "Method": "GET", + "RequestUri": "https://management.azure.com/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint1hc715gxy?api-version=2023-10-01", + "Content": null, + "isContentBase64": false, + "Headers": { + "x-ms-unique-id": [ "28" ], + "x-ms-client-request-id": [ "eab0c0d7-cff6-4579-a7e2-86846f4799bd" ], + "CommandName": [ "Get-AzStorageMoverEndpoint" ], + "FullCommandName": [ "Get-AzStorageMoverEndpoint_Get" ], + "ParameterSetName": [ "__AllParameterSets" ], + "User-Agent": [ "AzurePowershell/v0.0.0", "PSVersion/v7.2.12", "Az.StorageMover/1.0.1" ], + "Authorization": [ "[Filtered]" ] + }, + "ContentHeaders": { + } + }, + "Response": { + "StatusCode": 200, + "Headers": { + "Cache-Control": [ "no-cache" ], + "Pragma": [ "no-cache" ], + "ETag": [ "\"2d011c48-0000-3400-0000-64ba09a10000\"" ], + "x-ms-ratelimit-remaining-subscription-reads": [ "11983" ], + "x-ms-providerhub-traffic": [ "True" ], + "x-ms-request-id": [ "72a4ab1c-2a83-43d2-907c-d548019c4070" ], + "x-ms-correlation-request-id": [ "ebb30065-2430-421c-a32d-b594686cd04e" ], + "x-ms-routing-request-id": [ "EASTUS2EUAP:20230721T042922Z:ebb30065-2430-421c-a32d-b594686cd04e" ], + "Strict-Transport-Security": [ "max-age=31536000; includeSubDomains" ], + "X-Content-Type-Options": [ "nosniff" ], + "Date": [ "Fri, 21 Jul 2023 04:29:22 GMT" ] + }, + "ContentHeaders": { + "Content-Length": [ "887" ], + "Content-Type": [ "application/json; charset=utf-8" ], + "Expires": [ "-1" ] + }, + "Content": "{\"id\":\"/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint1hc715gxy\",\"name\":\"fseendpoint1hc715gxy\",\"type\":\"microsoft.storagemover/storagemovers/endpoints\",\"systemData\":{\"createdBy\":\"a000255f-5f09-45e0-a970-9d9ed9cc6453\",\"createdByType\":\"Application\",\"createdAt\":\"2023-07-21T04:29:21.5382807Z\",\"lastModifiedBy\":\"a000255f-5f09-45e0-a970-9d9ed9cc6453\",\"lastModifiedByType\":\"Application\",\"lastModifiedAt\":\"2023-07-21T04:29:21.5382807Z\"},\"properties\":{\"storageAccountResourceId\":\"/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.Storage/storageAccounts/storacchc715gxy\",\"fileShareName\":\"testfs\",\"endpointType\":\"AzureStorageSmbFileShare\",\"description\":\"New smb file share endpoint\",\"provisioningState\":\"Succeeded\"}}", + "isContentBase64": false + } + }, + "New/Update-AzStorageMoverAzSmbFileShareEndpoint+[NoContext]+Create and update+$GET+https://management.azure.com/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint2hc715gxy?api-version=2023-10-01+4": { + "Request": { + "Method": "GET", + "RequestUri": "https://management.azure.com/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint2hc715gxy?api-version=2023-10-01", + "Content": null, + "isContentBase64": false, + "Headers": { + "x-ms-unique-id": [ "28" ], + "x-ms-client-request-id": [ "eab0c0d7-cff6-4579-a7e2-86846f4799bd" ], + "CommandName": [ "Get-AzStorageMoverEndpoint" ], + "FullCommandName": [ "Get-AzStorageMoverEndpoint_Get" ], + "ParameterSetName": [ "__AllParameterSets" ], + "User-Agent": [ "AzurePowershell/v0.0.0", "PSVersion/v7.2.12", "Az.StorageMover/1.0.1" ], + "Authorization": [ "[Filtered]" ] + }, + "ContentHeaders": { + } + }, + "Response": { + "StatusCode": 200, + "Headers": { + "Cache-Control": [ "no-cache" ], + "Pragma": [ "no-cache" ], + "ETag": [ "\"2d011c48-0000-3400-0000-64ba09a10000\"" ], + "x-ms-ratelimit-remaining-subscription-reads": [ "11983" ], + "x-ms-providerhub-traffic": [ "True" ], + "x-ms-request-id": [ "72a4ab1c-2a83-43d2-907c-d548019c4070" ], + "x-ms-correlation-request-id": [ "ebb30065-2430-421c-a32d-b594686cd04e" ], + "x-ms-routing-request-id": [ "EASTUS2EUAP:20230721T042922Z:ebb30065-2430-421c-a32d-b594686cd04e" ], + "Strict-Transport-Security": [ "max-age=31536000; includeSubDomains" ], + "X-Content-Type-Options": [ "nosniff" ], + "Date": [ "Fri, 21 Jul 2023 04:29:22 GMT" ] + }, + "ContentHeaders": { + "Content-Length": [ "887" ], + "Content-Type": [ "application/json; charset=utf-8" ], + "Expires": [ "-1" ] + }, + "Content": "{\"id\":\"/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint2hc715gxy\",\"name\":\"fseendpoint2hc715gxy\",\"type\":\"microsoft.storagemover/storagemovers/endpoints\",\"systemData\":{\"createdBy\":\"a000255f-5f09-45e0-a970-9d9ed9cc6453\",\"createdByType\":\"Application\",\"createdAt\":\"2023-07-21T04:29:21.5382807Z\",\"lastModifiedBy\":\"a000255f-5f09-45e0-a970-9d9ed9cc6453\",\"lastModifiedByType\":\"Application\",\"lastModifiedAt\":\"2023-07-21T04:29:21.5382807Z\"},\"properties\":{\"storageAccountResourceId\":\"/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.Storage/storageAccounts/storacchc715gxy\",\"fileShareName\":\"testfs\",\"endpointType\":\"AzureStorageSmbFileShare\",\"description\":\"New smb file share endpoint\",\"provisioningState\":\"Succeeded\"}}", + "isContentBase64": false + } + }, + "New/Update-AzStorageMoverAzSmbFileShareEndpoint+[NoContext]+Create and update+$PATCH+https://management.azure.com/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint1hc715gxy?api-version=2023-10-01+5": { + "Request": { + "Method": "PATCH", + "RequestUri": "https://management.azure.com/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint1hc715gxy?api-version=2023-10-01", + "Content": "{\r\n \"properties\": {\r\n \"endpointType\": \"AzureStorageSmbFileShare\",\r\n \"description\": \"updated file share endpoint\"\r\n }\r\n}", + "isContentBase64": false, + "Headers": { + }, + "ContentHeaders": { + "Content-Type": [ "application/json" ], + "Content-Length": [ "127" ] + } + }, + "Response": { + "StatusCode": 200, + "Headers": { + "Cache-Control": [ "no-cache" ], + "Pragma": [ "no-cache" ], + "ETag": [ "\"2d011e48-0000-3400-0000-64ba09a30000\"" ], + "x-ms-ratelimit-remaining-subscription-writes": [ "1190" ], + "x-ms-providerhub-traffic": [ "True" ], + "mise-correlation-id": [ "e95db91d-a025-43c8-ad7e-c8c1fef0ae2a" ], + "x-ms-request-id": [ "968c861f-53fc-4d13-84a6-7ebcf88e590f" ], + "x-ms-correlation-request-id": [ "b0e3a516-516a-478c-b8f9-4b373e973817" ], + "x-ms-routing-request-id": [ "EASTUS2EUAP:20230721T042923Z:b0e3a516-516a-478c-b8f9-4b373e973817" ], + "Strict-Transport-Security": [ "max-age=31536000; includeSubDomains" ], + "X-Content-Type-Options": [ "nosniff" ], + "Date": [ "Fri, 21 Jul 2023 04:29:22 GMT" ] + }, + "ContentHeaders": { + "Content-Length": [ "887" ], + "Content-Type": [ "application/json; charset=utf-8" ], + "Expires": [ "-1" ] + }, + "Content": "{\"id\":\"/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint1hc715gxy\",\"name\":\"fseendpoint1hc715gxy\",\"type\":\"microsoft.storagemover/storagemovers/endpoints\",\"systemData\":{\"createdBy\":\"a000255f-5f09-45e0-a970-9d9ed9cc6453\",\"createdByType\":\"Application\",\"createdAt\":\"2023-07-21T04:29:21.5382807Z\",\"lastModifiedBy\":\"a000255f-5f09-45e0-a970-9d9ed9cc6453\",\"lastModifiedByType\":\"Application\",\"lastModifiedAt\":\"2023-07-21T04:29:23.3351405Z\"},\"properties\":{\"storageAccountResourceId\":\"/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.Storage/storageAccounts/storacchc715gxy\",\"fileShareName\":\"testfs\",\"endpointType\":\"AzureStorageSmbFileShare\",\"description\":\"updated file share endpoint\",\"provisioningState\":\"Succeeded\"}}", + "isContentBase64": false + } + }, + "New/Update-AzStorageMoverAzSmbFileShareEndpoint+[NoContext]+Create and update+$PATCH+https://management.azure.com/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint2hc715gxy?api-version=2023-10-01+6": { + "Request": { + "Method": "PATCH", + "RequestUri": "https://management.azure.com/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint2hc715gxy?api-version=2023-10-01", + "Content": "{\r\n \"properties\": {\r\n \"endpointType\": \"AzureStorageSmbFileShare\",\r\n \"description\": \"updated file share endpoint\"\r\n }\r\n}", + "isContentBase64": false, + "Headers": { + }, + "ContentHeaders": { + "Content-Type": [ "application/json" ], + "Content-Length": [ "127" ] + } + }, + "Response": { + "StatusCode": 200, + "Headers": { + "Cache-Control": [ "no-cache" ], + "Pragma": [ "no-cache" ], + "ETag": [ "\"2d011e48-0000-3400-0000-64ba09a30000\"" ], + "x-ms-ratelimit-remaining-subscription-writes": [ "1190" ], + "x-ms-providerhub-traffic": [ "True" ], + "mise-correlation-id": [ "e95db91d-a025-43c8-ad7e-c8c1fef0ae2a" ], + "x-ms-request-id": [ "968c861f-53fc-4d13-84a6-7ebcf88e590f" ], + "x-ms-correlation-request-id": [ "b0e3a516-516a-478c-b8f9-4b373e973817" ], + "x-ms-routing-request-id": [ "EASTUS2EUAP:20230721T042923Z:b0e3a516-516a-478c-b8f9-4b373e973817" ], + "Strict-Transport-Security": [ "max-age=31536000; includeSubDomains" ], + "X-Content-Type-Options": [ "nosniff" ], + "Date": [ "Fri, 21 Jul 2023 04:29:22 GMT" ] + }, + "ContentHeaders": { + "Content-Length": [ "887" ], + "Content-Type": [ "application/json; charset=utf-8" ], + "Expires": [ "-1" ] + }, + "Content": "{\"id\":\"/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint2hc715gxy\",\"name\":\"fseendpoint2hc715gxy\",\"type\":\"microsoft.storagemover/storagemovers/endpoints\",\"systemData\":{\"createdBy\":\"a000255f-5f09-45e0-a970-9d9ed9cc6453\",\"createdByType\":\"Application\",\"createdAt\":\"2023-07-21T04:29:21.5382807Z\",\"lastModifiedBy\":\"a000255f-5f09-45e0-a970-9d9ed9cc6453\",\"lastModifiedByType\":\"Application\",\"lastModifiedAt\":\"2023-07-21T04:29:23.3351405Z\"},\"properties\":{\"storageAccountResourceId\":\"/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.Storage/storageAccounts/storacchc715gxy\",\"fileShareName\":\"testfs\",\"endpointType\":\"AzureStorageSmbFileShare\",\"description\":\"updated file share endpoint\",\"provisioningState\":\"Succeeded\"}}", + "isContentBase64": false + } + }, + "New/Update-AzStorageMoverAzSmbFileShareEndpoint+[NoContext]+Create and update+$GET+https://management.azure.com/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint1hc715gxy?api-version=2023-10-01+7": { + "Request": { + "Method": "GET", + "RequestUri": "https://management.azure.com/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint1hc715gxy?api-version=2023-10-01", + "Content": null, + "isContentBase64": false, + "Headers": { + "x-ms-unique-id": [ "30" ], + "x-ms-client-request-id": [ "85576754-82ea-4f57-8474-d454a6b94cb6" ], + "CommandName": [ "Get-AzStorageMoverEndpoint" ], + "FullCommandName": [ "Get-AzStorageMoverEndpoint_Get" ], + "ParameterSetName": [ "__AllParameterSets" ], + "User-Agent": [ "AzurePowershell/v0.0.0", "PSVersion/v7.2.12", "Az.StorageMover/1.0.1" ], + "Authorization": [ "[Filtered]" ] + }, + "ContentHeaders": { + } + }, + "Response": { + "StatusCode": 200, + "Headers": { + "Cache-Control": [ "no-cache" ], + "Pragma": [ "no-cache" ], + "ETag": [ "\"2d011e48-0000-3400-0000-64ba09a30000\"" ], + "x-ms-ratelimit-remaining-subscription-reads": [ "11982" ], + "x-ms-providerhub-traffic": [ "True" ], + "x-ms-request-id": [ "8ce80585-3365-4d04-a990-11f76a56b502" ], + "x-ms-correlation-request-id": [ "d6eb34a0-daad-44d3-88cc-469f0299c03c" ], + "x-ms-routing-request-id": [ "EASTUS2EUAP:20230721T042924Z:d6eb34a0-daad-44d3-88cc-469f0299c03c" ], + "Strict-Transport-Security": [ "max-age=31536000; includeSubDomains" ], + "X-Content-Type-Options": [ "nosniff" ], + "Date": [ "Fri, 21 Jul 2023 04:29:24 GMT" ] + }, + "ContentHeaders": { + "Content-Length": [ "887" ], + "Content-Type": [ "application/json; charset=utf-8" ], + "Expires": [ "-1" ] + }, + "Content": "{\"id\":\"/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint1hc715gxy\",\"name\":\"fseendpoint1hc715gxy\",\"type\":\"microsoft.storagemover/storagemovers/endpoints\",\"systemData\":{\"createdBy\":\"a000255f-5f09-45e0-a970-9d9ed9cc6453\",\"createdByType\":\"Application\",\"createdAt\":\"2023-07-21T04:29:21.5382807Z\",\"lastModifiedBy\":\"a000255f-5f09-45e0-a970-9d9ed9cc6453\",\"lastModifiedByType\":\"Application\",\"lastModifiedAt\":\"2023-07-21T04:29:23.3351405Z\"},\"properties\":{\"storageAccountResourceId\":\"/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.Storage/storageAccounts/storacchc715gxy\",\"fileShareName\":\"testfs\",\"endpointType\":\"AzureStorageSmbFileShare\",\"description\":\"updated file share endpoint\",\"provisioningState\":\"Succeeded\"}}", + "isContentBase64": false + } + }, + "New/Update-AzStorageMoverAzSmbFileShareEndpoint+[NoContext]+Create and update+$GET+https://management.azure.com/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint2hc715gxy?api-version=2023-10-01+8": { + "Request": { + "Method": "GET", + "RequestUri": "https://management.azure.com/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint2hc715gxy?api-version=2023-10-01", + "Content": null, + "isContentBase64": false, + "Headers": { + "x-ms-unique-id": [ "30" ], + "x-ms-client-request-id": [ "85576754-82ea-4f57-8474-d454a6b94cb6" ], + "CommandName": [ "Get-AzStorageMoverEndpoint" ], + "FullCommandName": [ "Get-AzStorageMoverEndpoint_Get" ], + "ParameterSetName": [ "__AllParameterSets" ], + "User-Agent": [ "AzurePowershell/v0.0.0", "PSVersion/v7.2.12", "Az.StorageMover/1.0.1" ], + "Authorization": [ "[Filtered]" ] + }, + "ContentHeaders": { + } + }, + "Response": { + "StatusCode": 200, + "Headers": { + "Cache-Control": [ "no-cache" ], + "Pragma": [ "no-cache" ], + "ETag": [ "\"2d011e48-0000-3400-0000-64ba09a30000\"" ], + "x-ms-ratelimit-remaining-subscription-reads": [ "11982" ], + "x-ms-providerhub-traffic": [ "True" ], + "x-ms-request-id": [ "8ce80585-3365-4d04-a990-11f76a56b502" ], + "x-ms-correlation-request-id": [ "d6eb34a0-daad-44d3-88cc-469f0299c03c" ], + "x-ms-routing-request-id": [ "EASTUS2EUAP:20230721T042924Z:d6eb34a0-daad-44d3-88cc-469f0299c03c" ], + "Strict-Transport-Security": [ "max-age=31536000; includeSubDomains" ], + "X-Content-Type-Options": [ "nosniff" ], + "Date": [ "Fri, 21 Jul 2023 04:29:24 GMT" ] + }, + "ContentHeaders": { + "Content-Length": [ "887" ], + "Content-Type": [ "application/json; charset=utf-8" ], + "Expires": [ "-1" ] + }, + "Content": "{\"id\":\"/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint2hc715gxy\",\"name\":\"fseendpoint2hc715gxy\",\"type\":\"microsoft.storagemover/storagemovers/endpoints\",\"systemData\":{\"createdBy\":\"a000255f-5f09-45e0-a970-9d9ed9cc6453\",\"createdByType\":\"Application\",\"createdAt\":\"2023-07-21T04:29:21.5382807Z\",\"lastModifiedBy\":\"a000255f-5f09-45e0-a970-9d9ed9cc6453\",\"lastModifiedByType\":\"Application\",\"lastModifiedAt\":\"2023-07-21T04:29:23.3351405Z\"},\"properties\":{\"storageAccountResourceId\":\"/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.Storage/storageAccounts/storacchc715gxy\",\"fileShareName\":\"testfs\",\"endpointType\":\"AzureStorageSmbFileShare\",\"description\":\"updated file share endpoint\",\"provisioningState\":\"Succeeded\"}}", + "isContentBase64": false + } + } +} \ No newline at end of file diff --git a/src/StorageMover/StorageMover.Autorest/test/New-AzStorageMoverAzSmbFileShareEndpoint.Tests.ps1 b/src/StorageMover/StorageMover.Autorest/test/New-AzStorageMoverAzSmbFileShareEndpoint.Tests.ps1 new file mode 100644 index 000000000000..a9bccbd6988f --- /dev/null +++ b/src/StorageMover/StorageMover.Autorest/test/New-AzStorageMoverAzSmbFileShareEndpoint.Tests.ps1 @@ -0,0 +1,77 @@ +if(($null -eq $TestName) -or ($TestName -contains 'New/Update-AzStorageMoverAzSmbFileShareEndpoint')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'New-AzStorageMoverAzSmbFileShareEndpoint.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'New/Update-AzStorageMoverAzSmbFileShareEndpoint' { + It 'Create and update' { + $endpointName = "fseendpoint1" + $env.RandomString + $fsendpoint = New-AzStorageMoverAzSmbFileShareEndpoint -Name $endpointName -ResourceGroupName $env.ResourceGroupName -StorageMoverName $env.InitialStoMoverName -StorageAccountResourceId $env.StoraccId -FileShareName "testfs" -Description "New smb file share endpoint" + $fsendpoint.Name | Should -Be $endpointName + $fsendpoint.Property.EndpointType | Should -Be "AzureStorageSmbFileShare" + $fsendpoint.Property.Description | Should -Be "New smb file share endpoint" + $fsendpoint.Property.FileShareName | Should -Be "testfs" + $fsendpoint.Property.StorageAccountResourceId | Should -Be $env.StoraccId + + $endpointName2 = "fseendpoint2" + $env.RandomString + $fsendpoint = New-AzStorageMoverSmbFileShareEndpoint -Name $endpointName2 -ResourceGroupName $env.ResourceGroupName -StorageMoverName $env.InitialStoMoverName -StorageAccountResourceId $env.StoraccId -FileShareName "testfs" -Description "New smb file share endpoint" + $fsendpoint.Name | Should -Be $endpointName2 + $fsendpoint.Property.EndpointType | Should -Be "AzureStorageSmbFileShare" + $fsendpoint.Property.Description | Should -Be "New smb file share endpoint" + $fsendpoint.Property.FileShareName | Should -Be "testfs" + $fsendpoint.Property.StorageAccountResourceId | Should -Be $env.StoraccId + + $fsendpoint = Get-AzStorageMoverEndpoint -Name $endpointName -ResourceGroupName $env.ResourceGroupName -StorageMoverName $env.InitialStoMoverName + $fsendpoint.Name | Should -Be $endpointName + $fsendpoint.Property.EndpointType | Should -Be "AzureStorageSmbFileShare" + $fsendpoint.Property.Description | Should -Be "New smb file share endpoint" + $fsendpoint.Property.FileShareName | Should -Be "testfs" + $fsendpoint.Property.StorageAccountResourceId | Should -Be $env.StoraccId + + $fsendpoint = Get-AzStorageMoverEndpoint -Name $endpointName2 -ResourceGroupName $env.ResourceGroupName -StorageMoverName $env.InitialStoMoverName + $fsendpoint.Name | Should -Be $endpointName2 + $fsendpoint.Property.EndpointType | Should -Be "AzureStorageSmbFileShare" + $fsendpoint.Property.Description | Should -Be "New smb file share endpoint" + $fsendpoint.Property.FileShareName | Should -Be "testfs" + $fsendpoint.Property.StorageAccountResourceId | Should -Be $env.StoraccId + + $fsendpoint = Update-AzStorageMoverAzSmbFileShareEndpoint -Name $endpointName -ResourceGroupName $env.ResourceGroupName -StorageMoverName $env.InitialStoMoverName -Description "updated file share endpoint" + $fsendpoint.Name | Should -Be $endpointName + $fsendpoint.Property.EndpointType | Should -Be "AzureStorageSmbFileShare" + $fsendpoint.Property.Description | Should -Be "updated file share endpoint" + $fsendpoint.Property.FileShareName | Should -Be "testfs" + $fsendpoint.Property.StorageAccountResourceId | Should -Be $env.StoraccId + + $fsendpoint = Update-AzStorageMoverSmbFileShareEndpoint -Name $endpointName2 -ResourceGroupName $env.ResourceGroupName -StorageMoverName $env.InitialStoMoverName -Description "updated file share endpoint" + $fsendpoint.Name | Should -Be $endpointName2 + $fsendpoint.Property.EndpointType | Should -Be "AzureStorageSmbFileShare" + $fsendpoint.Property.Description | Should -Be "updated file share endpoint" + $fsendpoint.Property.FileShareName | Should -Be "testfs" + $fsendpoint.Property.StorageAccountResourceId | Should -Be $env.StoraccId + + $fsendpoint = Get-AzStorageMoverEndpoint -Name $endpointName -ResourceGroupName $env.ResourceGroupName -StorageMoverName $env.InitialStoMoverName + $fsendpoint.Name | Should -Be $endpointName + $fsendpoint.Property.EndpointType | Should -Be "AzureStorageSmbFileShare" + $fsendpoint.Property.Description | Should -Be "updated file share endpoint" + $fsendpoint.Property.FileShareName | Should -Be "testfs" + $fsendpoint.Property.StorageAccountResourceId | Should -Be $env.StoraccId + + $fsendpoint = Get-AzStorageMoverEndpoint -Name $endpointName2 -ResourceGroupName $env.ResourceGroupName -StorageMoverName $env.InitialStoMoverName + $fsendpoint.Name | Should -Be $endpointName2 + $fsendpoint.Property.EndpointType | Should -Be "AzureStorageSmbFileShare" + $fsendpoint.Property.Description | Should -Be "updated file share endpoint" + $fsendpoint.Property.FileShareName | Should -Be "testfs" + $fsendpoint.Property.StorageAccountResourceId | Should -Be $env.StoraccId + } +} diff --git a/src/StorageMover/StorageMover.Autorest/test/New-AzStorageMoverSmbFileShareEndpoint.Recording.json b/src/StorageMover/StorageMover.Autorest/test/New-AzStorageMoverSmbFileShareEndpoint.Recording.json deleted file mode 100644 index 6d6c5b892907..000000000000 --- a/src/StorageMover/StorageMover.Autorest/test/New-AzStorageMoverSmbFileShareEndpoint.Recording.json +++ /dev/null @@ -1,162 +0,0 @@ -{ - "New/Update-AzStorageMoverSmbFileShareEndpoint+[NoContext]+Create and update+$PUT+https://management.azure.com/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint1hc715gxy?api-version=2023-10-01+1": { - "Request": { - "Method": "PUT", - "RequestUri": "https://management.azure.com/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint1hc715gxy?api-version=2023-10-01", - "Content": "{\r\n \"properties\": {\r\n \"endpointType\": \"AzureStorageSmbFileShare\",\r\n \"description\": \"New smb file share endpoint\",\r\n \"storageAccountResourceId\": \"/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.Storage/storageAccounts/storacchc715gxy\",\r\n \"fileShareName\": \"testfs\"\r\n }\r\n}", - "isContentBase64": false, - "Headers": { - }, - "ContentHeaders": { - "Content-Type": [ "application/json" ], - "Content-Length": [ "339" ] - } - }, - "Response": { - "StatusCode": 200, - "Headers": { - "Cache-Control": [ "no-cache" ], - "Pragma": [ "no-cache" ], - "ETag": [ "\"2d011c48-0000-3400-0000-64ba09a10000\"" ], - "x-ms-ratelimit-remaining-subscription-writes": [ "1191" ], - "x-ms-providerhub-traffic": [ "True" ], - "mise-correlation-id": [ "e2ca2827-3c7e-4a2e-808e-13d705e41049" ], - "x-ms-request-id": [ "e186296f-e455-44e8-9af2-5c510c5aaf96" ], - "x-ms-correlation-request-id": [ "fed03c95-e2aa-49e8-b6ee-816a857127d7" ], - "x-ms-routing-request-id": [ "EASTUS2EUAP:20230721T042921Z:fed03c95-e2aa-49e8-b6ee-816a857127d7" ], - "Strict-Transport-Security": [ "max-age=31536000; includeSubDomains" ], - "X-Content-Type-Options": [ "nosniff" ], - "Date": [ "Fri, 21 Jul 2023 04:29:21 GMT" ] - }, - "ContentHeaders": { - "Content-Length": [ "887" ], - "Content-Type": [ "application/json; charset=utf-8" ], - "Expires": [ "-1" ] - }, - "Content": "{\"id\":\"/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint1hc715gxy\",\"name\":\"fseendpoint1hc715gxy\",\"type\":\"microsoft.storagemover/storagemovers/endpoints\",\"systemData\":{\"createdBy\":\"a000255f-5f09-45e0-a970-9d9ed9cc6453\",\"createdByType\":\"Application\",\"createdAt\":\"2023-07-21T04:29:21.5382807Z\",\"lastModifiedBy\":\"a000255f-5f09-45e0-a970-9d9ed9cc6453\",\"lastModifiedByType\":\"Application\",\"lastModifiedAt\":\"2023-07-21T04:29:21.5382807Z\"},\"properties\":{\"storageAccountResourceId\":\"/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.Storage/storageAccounts/storacchc715gxy\",\"fileShareName\":\"testfs\",\"endpointType\":\"AzureStorageSmbFileShare\",\"description\":\"New smb file share endpoint\",\"provisioningState\":\"Succeeded\"}}", - "isContentBase64": false - } - }, - "New/Update-AzStorageMoverSmbFileShareEndpoint+[NoContext]+Create and update+$GET+https://management.azure.com/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint1hc715gxy?api-version=2023-10-01+2": { - "Request": { - "Method": "GET", - "RequestUri": "https://management.azure.com/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint1hc715gxy?api-version=2023-10-01", - "Content": null, - "isContentBase64": false, - "Headers": { - "x-ms-unique-id": [ "28" ], - "x-ms-client-request-id": [ "eab0c0d7-cff6-4579-a7e2-86846f4799bd" ], - "CommandName": [ "Get-AzStorageMoverEndpoint" ], - "FullCommandName": [ "Get-AzStorageMoverEndpoint_Get" ], - "ParameterSetName": [ "__AllParameterSets" ], - "User-Agent": [ "AzurePowershell/v0.0.0", "PSVersion/v7.2.12", "Az.StorageMover/1.0.1" ], - "Authorization": [ "[Filtered]" ] - }, - "ContentHeaders": { - } - }, - "Response": { - "StatusCode": 200, - "Headers": { - "Cache-Control": [ "no-cache" ], - "Pragma": [ "no-cache" ], - "ETag": [ "\"2d011c48-0000-3400-0000-64ba09a10000\"" ], - "x-ms-ratelimit-remaining-subscription-reads": [ "11983" ], - "x-ms-providerhub-traffic": [ "True" ], - "x-ms-request-id": [ "72a4ab1c-2a83-43d2-907c-d548019c4070" ], - "x-ms-correlation-request-id": [ "ebb30065-2430-421c-a32d-b594686cd04e" ], - "x-ms-routing-request-id": [ "EASTUS2EUAP:20230721T042922Z:ebb30065-2430-421c-a32d-b594686cd04e" ], - "Strict-Transport-Security": [ "max-age=31536000; includeSubDomains" ], - "X-Content-Type-Options": [ "nosniff" ], - "Date": [ "Fri, 21 Jul 2023 04:29:22 GMT" ] - }, - "ContentHeaders": { - "Content-Length": [ "887" ], - "Content-Type": [ "application/json; charset=utf-8" ], - "Expires": [ "-1" ] - }, - "Content": "{\"id\":\"/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint1hc715gxy\",\"name\":\"fseendpoint1hc715gxy\",\"type\":\"microsoft.storagemover/storagemovers/endpoints\",\"systemData\":{\"createdBy\":\"a000255f-5f09-45e0-a970-9d9ed9cc6453\",\"createdByType\":\"Application\",\"createdAt\":\"2023-07-21T04:29:21.5382807Z\",\"lastModifiedBy\":\"a000255f-5f09-45e0-a970-9d9ed9cc6453\",\"lastModifiedByType\":\"Application\",\"lastModifiedAt\":\"2023-07-21T04:29:21.5382807Z\"},\"properties\":{\"storageAccountResourceId\":\"/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.Storage/storageAccounts/storacchc715gxy\",\"fileShareName\":\"testfs\",\"endpointType\":\"AzureStorageSmbFileShare\",\"description\":\"New smb file share endpoint\",\"provisioningState\":\"Succeeded\"}}", - "isContentBase64": false - } - }, - "New/Update-AzStorageMoverSmbFileShareEndpoint+[NoContext]+Create and update+$PATCH+https://management.azure.com/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint1hc715gxy?api-version=2023-10-01+3": { - "Request": { - "Method": "PATCH", - "RequestUri": "https://management.azure.com/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint1hc715gxy?api-version=2023-10-01", - "Content": "{\r\n \"properties\": {\r\n \"endpointType\": \"AzureStorageSmbFileShare\",\r\n \"description\": \"updated file share endpoint\"\r\n }\r\n}", - "isContentBase64": false, - "Headers": { - }, - "ContentHeaders": { - "Content-Type": [ "application/json" ], - "Content-Length": [ "127" ] - } - }, - "Response": { - "StatusCode": 200, - "Headers": { - "Cache-Control": [ "no-cache" ], - "Pragma": [ "no-cache" ], - "ETag": [ "\"2d011e48-0000-3400-0000-64ba09a30000\"" ], - "x-ms-ratelimit-remaining-subscription-writes": [ "1190" ], - "x-ms-providerhub-traffic": [ "True" ], - "mise-correlation-id": [ "e95db91d-a025-43c8-ad7e-c8c1fef0ae2a" ], - "x-ms-request-id": [ "968c861f-53fc-4d13-84a6-7ebcf88e590f" ], - "x-ms-correlation-request-id": [ "b0e3a516-516a-478c-b8f9-4b373e973817" ], - "x-ms-routing-request-id": [ "EASTUS2EUAP:20230721T042923Z:b0e3a516-516a-478c-b8f9-4b373e973817" ], - "Strict-Transport-Security": [ "max-age=31536000; includeSubDomains" ], - "X-Content-Type-Options": [ "nosniff" ], - "Date": [ "Fri, 21 Jul 2023 04:29:22 GMT" ] - }, - "ContentHeaders": { - "Content-Length": [ "887" ], - "Content-Type": [ "application/json; charset=utf-8" ], - "Expires": [ "-1" ] - }, - "Content": "{\"id\":\"/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint1hc715gxy\",\"name\":\"fseendpoint1hc715gxy\",\"type\":\"microsoft.storagemover/storagemovers/endpoints\",\"systemData\":{\"createdBy\":\"a000255f-5f09-45e0-a970-9d9ed9cc6453\",\"createdByType\":\"Application\",\"createdAt\":\"2023-07-21T04:29:21.5382807Z\",\"lastModifiedBy\":\"a000255f-5f09-45e0-a970-9d9ed9cc6453\",\"lastModifiedByType\":\"Application\",\"lastModifiedAt\":\"2023-07-21T04:29:23.3351405Z\"},\"properties\":{\"storageAccountResourceId\":\"/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.Storage/storageAccounts/storacchc715gxy\",\"fileShareName\":\"testfs\",\"endpointType\":\"AzureStorageSmbFileShare\",\"description\":\"updated file share endpoint\",\"provisioningState\":\"Succeeded\"}}", - "isContentBase64": false - } - }, - "New/Update-AzStorageMoverSmbFileShareEndpoint+[NoContext]+Create and update+$GET+https://management.azure.com/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint1hc715gxy?api-version=2023-10-01+4": { - "Request": { - "Method": "GET", - "RequestUri": "https://management.azure.com/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint1hc715gxy?api-version=2023-10-01", - "Content": null, - "isContentBase64": false, - "Headers": { - "x-ms-unique-id": [ "30" ], - "x-ms-client-request-id": [ "85576754-82ea-4f57-8474-d454a6b94cb6" ], - "CommandName": [ "Get-AzStorageMoverEndpoint" ], - "FullCommandName": [ "Get-AzStorageMoverEndpoint_Get" ], - "ParameterSetName": [ "__AllParameterSets" ], - "User-Agent": [ "AzurePowershell/v0.0.0", "PSVersion/v7.2.12", "Az.StorageMover/1.0.1" ], - "Authorization": [ "[Filtered]" ] - }, - "ContentHeaders": { - } - }, - "Response": { - "StatusCode": 200, - "Headers": { - "Cache-Control": [ "no-cache" ], - "Pragma": [ "no-cache" ], - "ETag": [ "\"2d011e48-0000-3400-0000-64ba09a30000\"" ], - "x-ms-ratelimit-remaining-subscription-reads": [ "11982" ], - "x-ms-providerhub-traffic": [ "True" ], - "x-ms-request-id": [ "8ce80585-3365-4d04-a990-11f76a56b502" ], - "x-ms-correlation-request-id": [ "d6eb34a0-daad-44d3-88cc-469f0299c03c" ], - "x-ms-routing-request-id": [ "EASTUS2EUAP:20230721T042924Z:d6eb34a0-daad-44d3-88cc-469f0299c03c" ], - "Strict-Transport-Security": [ "max-age=31536000; includeSubDomains" ], - "X-Content-Type-Options": [ "nosniff" ], - "Date": [ "Fri, 21 Jul 2023 04:29:24 GMT" ] - }, - "ContentHeaders": { - "Content-Length": [ "887" ], - "Content-Type": [ "application/json; charset=utf-8" ], - "Expires": [ "-1" ] - }, - "Content": "{\"id\":\"/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.StorageMover/storageMovers/testStoMover1hc715gxy/endpoints/fseendpoint1hc715gxy\",\"name\":\"fseendpoint1hc715gxy\",\"type\":\"microsoft.storagemover/storagemovers/endpoints\",\"systemData\":{\"createdBy\":\"a000255f-5f09-45e0-a970-9d9ed9cc6453\",\"createdByType\":\"Application\",\"createdAt\":\"2023-07-21T04:29:21.5382807Z\",\"lastModifiedBy\":\"a000255f-5f09-45e0-a970-9d9ed9cc6453\",\"lastModifiedByType\":\"Application\",\"lastModifiedAt\":\"2023-07-21T04:29:23.3351405Z\"},\"properties\":{\"storageAccountResourceId\":\"/subscriptions/45b60d85-fd72-427a-a708-f994d26e593e/resourceGroups/teststoragemover/providers/Microsoft.Storage/storageAccounts/storacchc715gxy\",\"fileShareName\":\"testfs\",\"endpointType\":\"AzureStorageSmbFileShare\",\"description\":\"updated file share endpoint\",\"provisioningState\":\"Succeeded\"}}", - "isContentBase64": false - } - } -} \ No newline at end of file diff --git a/src/StorageMover/StorageMover.Autorest/test/New-AzStorageMoverSmbFileShareEndpoint.Tests.ps1 b/src/StorageMover/StorageMover.Autorest/test/New-AzStorageMoverSmbFileShareEndpoint.Tests.ps1 deleted file mode 100644 index 3fb64c540695..000000000000 --- a/src/StorageMover/StorageMover.Autorest/test/New-AzStorageMoverSmbFileShareEndpoint.Tests.ps1 +++ /dev/null @@ -1,48 +0,0 @@ -if(($null -eq $TestName) -or ($TestName -contains 'New-AzStorageMoverSmbFileShareEndpoint')) -{ - $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' - if (-Not (Test-Path -Path $loadEnvPath)) { - $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' - } - . ($loadEnvPath) - $TestRecordingFile = Join-Path $PSScriptRoot 'New-AzStorageMoverSmbFileShareEndpoint.Recording.json' - $currentPath = $PSScriptRoot - while(-not $mockingPath) { - $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File - $currentPath = Split-Path -Path $currentPath -Parent - } - . ($mockingPath | Select-Object -First 1).FullName -} - -Describe 'New/Update-AzStorageMoverSmbFileShareEndpoint' { - It 'Create and update' { - $endpointName = "fseendpoint1" + $env.RandomString - $fsendpoint = New-AzStorageMoverSmbFileShareEndpoint -Name $endpointName -ResourceGroupName $env.ResourceGroupName -StorageMoverName $env.InitialStoMoverName -StorageAccountResourceId $env.StoraccId -FileShareName "testfs" -Description "New smb file share endpoint" - $fsendpoint.Name | Should -Be $endpointName - $fsendpoint.Property.EndpointType | Should -Be "AzureStorageSmbFileShare" - $fsendpoint.Property.Description | Should -Be "New smb file share endpoint" - $fsendpoint.Property.FileShareName | Should -Be "testfs" - $fsendpoint.Property.StorageAccountResourceId | Should -Be $env.StoraccId - - $fsendpoint = Get-AzStorageMoverEndpoint -Name $endpointName -ResourceGroupName $env.ResourceGroupName -StorageMoverName $env.InitialStoMoverName - $fsendpoint.Name | Should -Be $endpointName - $fsendpoint.Property.EndpointType | Should -Be "AzureStorageSmbFileShare" - $fsendpoint.Property.Description | Should -Be "New smb file share endpoint" - $fsendpoint.Property.FileShareName | Should -Be "testfs" - $fsendpoint.Property.StorageAccountResourceId | Should -Be $env.StoraccId - - $fsendpoint = Update-AzStorageMoverSmbFileShareEndpoint -Name $endpointName -ResourceGroupName $env.ResourceGroupName -StorageMoverName $env.InitialStoMoverName -Description "updated file share endpoint" - $fsendpoint.Name | Should -Be $endpointName - $fsendpoint.Property.EndpointType | Should -Be "AzureStorageSmbFileShare" - $fsendpoint.Property.Description | Should -Be "updated file share endpoint" - $fsendpoint.Property.FileShareName | Should -Be "testfs" - $fsendpoint.Property.StorageAccountResourceId | Should -Be $env.StoraccId - - $fsendpoint = Get-AzStorageMoverEndpoint -Name $endpointName -ResourceGroupName $env.ResourceGroupName -StorageMoverName $env.InitialStoMoverName - $fsendpoint.Name | Should -Be $endpointName - $fsendpoint.Property.EndpointType | Should -Be "AzureStorageSmbFileShare" - $fsendpoint.Property.Description | Should -Be "updated file share endpoint" - $fsendpoint.Property.FileShareName | Should -Be "testfs" - $fsendpoint.Property.StorageAccountResourceId | Should -Be $env.StoraccId - } -} diff --git a/src/StorageMover/StorageMover.Autorest/test/Update-AzStorageMoverSmbFileShareEndpoint.Tests.ps1 b/src/StorageMover/StorageMover.Autorest/test/Update-AzStorageMoverAzSmbFileShareEndpoint.Tests.ps1 similarity index 86% rename from src/StorageMover/StorageMover.Autorest/test/Update-AzStorageMoverSmbFileShareEndpoint.Tests.ps1 rename to src/StorageMover/StorageMover.Autorest/test/Update-AzStorageMoverAzSmbFileShareEndpoint.Tests.ps1 index 284a450b908b..16cc2f6a8df9 100644 --- a/src/StorageMover/StorageMover.Autorest/test/Update-AzStorageMoverSmbFileShareEndpoint.Tests.ps1 +++ b/src/StorageMover/StorageMover.Autorest/test/Update-AzStorageMoverAzSmbFileShareEndpoint.Tests.ps1 @@ -1,11 +1,11 @@ -if(($null -eq $TestName) -or ($TestName -contains 'Update-AzStorageMoverSmbFileShareEndpoint')) +if(($null -eq $TestName) -or ($TestName -contains 'Update-AzStorageMoverAzSmbFileShareEndpoint')) { $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' if (-Not (Test-Path -Path $loadEnvPath)) { $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' } . ($loadEnvPath) - $TestRecordingFile = Join-Path $PSScriptRoot 'Update-AzStorageMoverSmbFileShareEndpoint.Recording.json' + $TestRecordingFile = Join-Path $PSScriptRoot 'Update-AzStorageMoverAzSmbFileShareEndpoint.Recording.json' $currentPath = $PSScriptRoot while(-not $mockingPath) { $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File @@ -14,7 +14,7 @@ if(($null -eq $TestName) -or ($TestName -contains 'Update-AzStorageMoverSmbFileS . ($mockingPath | Select-Object -First 1).FullName } -Describe 'Update-AzStorageMoverSmbFileShareEndpoint' { +Describe 'Update-AzStorageMoverAzSmbFileShareEndpoint' { It 'UpdateExpanded' -skip { { throw [System.NotImplementedException] } | Should -Not -Throw } diff --git a/src/StorageMover/StorageMover/Az.StorageMover.psd1 b/src/StorageMover/StorageMover/Az.StorageMover.psd1 index 3254917d7e46..afc80eb9b1ff 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/5/2023 +# Generated on: 12/15/2023 # @{ @@ -51,7 +51,7 @@ 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.13.1'; }) +RequiredModules = @(@{ModuleName = 'Az.Accounts'; ModuleVersion = '2.13.2'; }) # Assemblies that must be loaded prior to importing this module RequiredAssemblies = 'StorageMover.Autorest/bin/Az.StorageMover.private.dll' @@ -72,22 +72,21 @@ NestedModules = @('StorageMover.Autorest/Az.StorageMover.psm1') FunctionsToExport = 'Get-AzStorageMover', 'Get-AzStorageMoverAgent', 'Get-AzStorageMoverEndpoint', 'Get-AzStorageMoverJobDefinition', 'Get-AzStorageMoverJobRun', 'Get-AzStorageMoverProject', - 'New-AzStorageMover', + 'New-AzStorageMover', 'New-AzStorageMoverAzSmbFileShareEndpoint', 'New-AzStorageMoverAzStorageContainerEndpoint', 'New-AzStorageMoverJobDefinition', 'New-AzStorageMoverNfsEndpoint', 'New-AzStorageMoverProject', 'New-AzStorageMoverSmbEndpoint', - 'New-AzStorageMoverSmbFileShareEndpoint', 'Remove-AzStorageMover', - 'Remove-AzStorageMoverEndpoint', + 'Remove-AzStorageMover', 'Remove-AzStorageMoverEndpoint', 'Remove-AzStorageMoverJobDefinition', 'Remove-AzStorageMoverProject', 'Start-AzStorageMoverJobDefinition', 'Stop-AzStorageMoverJobDefinition', 'Unregister-AzStorageMoverAgent', 'Update-AzStorageMover', 'Update-AzStorageMoverAgent', + 'Update-AzStorageMoverAzSmbFileShareEndpoint', 'Update-AzStorageMoverAzStorageContainerEndpoint', 'Update-AzStorageMoverJobDefinition', 'Update-AzStorageMoverNfsEndpoint', 'Update-AzStorageMoverProject', - 'Update-AzStorageMoverSmbEndpoint', - 'Update-AzStorageMoverSmbFileShareEndpoint' + 'Update-AzStorageMoverSmbEndpoint' # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export. CmdletsToExport = @() @@ -96,7 +95,8 @@ CmdletsToExport = @() # VariablesToExport = @() # Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export. -AliasesToExport = @() +AliasesToExport = 'New-AzStorageMoverSmbFileShareEndpoint', + 'Update-AzStorageMoverSmbFileShareEndpoint' # DSC resources to export from this module # DscResourcesToExport = @() diff --git a/src/StorageMover/StorageMover/ChangeLog.md b/src/StorageMover/StorageMover/ChangeLog.md index 6a1c3fe0866f..81f638432e75 100644 --- a/src/StorageMover/StorageMover/ChangeLog.md +++ b/src/StorageMover/StorageMover/ChangeLog.md @@ -18,6 +18,7 @@ - Additional information about change #1 --> ## Upcoming Release +* Renamed SmbFileShare endpoint cmdlets ## Version 1.2.0 * Supported SmbFileShareEndpoint and SmbEndpoint diff --git a/src/StorageMover/StorageMover/help/Get-AzStorageMover.md b/src/StorageMover/StorageMover/help/Get-AzStorageMover.md index 853ba4d09b28..ffacc62c12f5 100644 --- a/src/StorageMover/StorageMover/help/Get-AzStorageMover.md +++ b/src/StorageMover/StorageMover/help/Get-AzStorageMover.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.StorageMover-help.xml Module Name: Az.StorageMover online version: https://learn.microsoft.com/powershell/module/az.storagemover/get-azstoragemover schema: 2.0.0 @@ -23,17 +23,17 @@ Get-AzStorageMover -Name -ResourceGroupName [-SubscriptionId < [-DefaultProfile ] [] ``` -### GetViaIdentity -``` -Get-AzStorageMover -InputObject [-DefaultProfile ] [] -``` - ### List1 ``` Get-AzStorageMover -ResourceGroupName [-SubscriptionId ] [-DefaultProfile ] [] ``` +### GetViaIdentity +``` +Get-AzStorageMover -InputObject [-DefaultProfile ] [] +``` + ## DESCRIPTION Gets a Storage Mover resource. @@ -41,7 +41,7 @@ Gets a Storage Mover resource. ### Example 1: Get all Storage movers in a subcription ```powershell - Get-AzStorageMover +Get-AzStorageMover ``` ```output @@ -204,7 +204,7 @@ The ID of the target subscription. ```yaml Type: System.String[] -Parameter Sets: Get, List, List1 +Parameter Sets: List, Get, List1 Aliases: Required: False @@ -228,4 +228,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/StorageMover/StorageMover/help/Get-AzStorageMoverAgent.md b/src/StorageMover/StorageMover/help/Get-AzStorageMoverAgent.md index 7e7e22dc2908..583441bbaf8e 100644 --- a/src/StorageMover/StorageMover/help/Get-AzStorageMoverAgent.md +++ b/src/StorageMover/StorageMover/help/Get-AzStorageMoverAgent.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.StorageMover-help.xml Module Name: Az.StorageMover online version: https://learn.microsoft.com/powershell/module/az.storagemover/get-azstoragemoveragent schema: 2.0.0 @@ -153,7 +153,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: Get, List +Parameter Sets: List, Get Aliases: Required: True @@ -168,7 +168,7 @@ The name of the Storage Mover resource. ```yaml Type: System.String -Parameter Sets: Get, List +Parameter Sets: List, Get Aliases: Required: True @@ -183,7 +183,7 @@ The ID of the target subscription. ```yaml Type: System.String[] -Parameter Sets: Get, List +Parameter Sets: List, Get Aliases: Required: False @@ -207,4 +207,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/StorageMover/StorageMover/help/Get-AzStorageMoverEndpoint.md b/src/StorageMover/StorageMover/help/Get-AzStorageMoverEndpoint.md index b24a4b493f38..a3d9544924ac 100644 --- a/src/StorageMover/StorageMover/help/Get-AzStorageMoverEndpoint.md +++ b/src/StorageMover/StorageMover/help/Get-AzStorageMoverEndpoint.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.StorageMover-help.xml Module Name: Az.StorageMover online version: https://learn.microsoft.com/powershell/module/az.storagemover/get-azstoragemoverendpoint schema: 2.0.0 @@ -156,7 +156,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: Get, List +Parameter Sets: List, Get Aliases: Required: True @@ -171,7 +171,7 @@ The name of the Storage Mover resource. ```yaml Type: System.String -Parameter Sets: Get, List +Parameter Sets: List, Get Aliases: Required: True @@ -186,7 +186,7 @@ The ID of the target subscription. ```yaml Type: System.String[] -Parameter Sets: Get, List +Parameter Sets: List, Get Aliases: Required: False @@ -210,4 +210,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/StorageMover/StorageMover/help/Get-AzStorageMoverJobDefinition.md b/src/StorageMover/StorageMover/help/Get-AzStorageMoverJobDefinition.md index 2974721bdf73..f42703cf4efe 100644 --- a/src/StorageMover/StorageMover/help/Get-AzStorageMoverJobDefinition.md +++ b/src/StorageMover/StorageMover/help/Get-AzStorageMoverJobDefinition.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.StorageMover-help.xml Module Name: Az.StorageMover online version: https://learn.microsoft.com/powershell/module/az.storagemover/get-azstoragemoverjobdefinition schema: 2.0.0 @@ -37,7 +37,7 @@ Gets a Job Definition resource. ### Example 1: Get all job definitions under a Storage mover ```powershell -Get-AzStorageMoverJobDefinition -ProjectName myProject -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover +Get-AzStorageMoverJobDefinition -ProjectName myProject -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover ``` ```output @@ -155,7 +155,7 @@ The name of the Project resource. ```yaml Type: System.String -Parameter Sets: Get, List +Parameter Sets: List, Get Aliases: Required: True @@ -171,7 +171,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: Get, List +Parameter Sets: List, Get Aliases: Required: True @@ -186,7 +186,7 @@ The name of the Storage Mover resource. ```yaml Type: System.String -Parameter Sets: Get, List +Parameter Sets: List, Get Aliases: Required: True @@ -201,7 +201,7 @@ The ID of the target subscription. ```yaml Type: System.String[] -Parameter Sets: Get, List +Parameter Sets: List, Get Aliases: Required: False @@ -225,4 +225,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/StorageMover/StorageMover/help/Get-AzStorageMoverJobRun.md b/src/StorageMover/StorageMover/help/Get-AzStorageMoverJobRun.md index 5d468c5689f9..2b295f43bdf7 100644 --- a/src/StorageMover/StorageMover/help/Get-AzStorageMoverJobRun.md +++ b/src/StorageMover/StorageMover/help/Get-AzStorageMoverJobRun.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.StorageMover-help.xml Module Name: Az.StorageMover online version: https://learn.microsoft.com/powershell/module/az.storagemover/get-azstoragemoverjobrun schema: 2.0.0 @@ -27,8 +27,7 @@ Get-AzStorageMoverJobRun -JobDefinitionName -Name -ProjectName ### GetViaIdentity ``` -Get-AzStorageMoverJobRun -InputObject [-DefaultProfile ] - [] +Get-AzStorageMoverJobRun -InputObject [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -181,7 +180,7 @@ The name of the Job Definition resource. ```yaml Type: System.String -Parameter Sets: Get, List +Parameter Sets: List, Get Aliases: Required: True @@ -211,7 +210,7 @@ The name of the Project resource. ```yaml Type: System.String -Parameter Sets: Get, List +Parameter Sets: List, Get Aliases: Required: True @@ -227,7 +226,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: Get, List +Parameter Sets: List, Get Aliases: Required: True @@ -242,7 +241,7 @@ The name of the Storage Mover resource. ```yaml Type: System.String -Parameter Sets: Get, List +Parameter Sets: List, Get Aliases: Required: True @@ -257,7 +256,7 @@ The ID of the target subscription. ```yaml Type: System.String[] -Parameter Sets: Get, List +Parameter Sets: List, Get Aliases: Required: False @@ -281,4 +280,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/StorageMover/StorageMover/help/Get-AzStorageMoverProject.md b/src/StorageMover/StorageMover/help/Get-AzStorageMoverProject.md index 56c032067bd7..5a2786a0d7fd 100644 --- a/src/StorageMover/StorageMover/help/Get-AzStorageMoverProject.md +++ b/src/StorageMover/StorageMover/help/Get-AzStorageMoverProject.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.StorageMover-help.xml Module Name: Az.StorageMover online version: https://learn.microsoft.com/powershell/module/az.storagemover/get-azstoragemoverproject schema: 2.0.0 @@ -35,7 +35,7 @@ Gets a Project resource. ## EXAMPLES -### Example 1: Get all projects under a Storage mover +### Example 1: Get all projects under a Storage mover ```powershell $projectList = Get-AzStorageMoverProject -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover ``` @@ -144,7 +144,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: Get, List +Parameter Sets: List, Get Aliases: Required: True @@ -159,7 +159,7 @@ The name of the Storage Mover resource. ```yaml Type: System.String -Parameter Sets: Get, List +Parameter Sets: List, Get Aliases: Required: True @@ -174,7 +174,7 @@ The ID of the target subscription. ```yaml Type: System.String[] -Parameter Sets: Get, List +Parameter Sets: List, Get Aliases: Required: False @@ -198,4 +198,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/StorageMover/StorageMover/help/New-AzStorageMover.md b/src/StorageMover/StorageMover/help/New-AzStorageMover.md index b3159748e7d4..3834b6981b65 100644 --- a/src/StorageMover/StorageMover/help/New-AzStorageMover.md +++ b/src/StorageMover/StorageMover/help/New-AzStorageMover.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.StorageMover-help.xml Module Name: Az.StorageMover online version: https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemover schema: 2.0.0 @@ -14,15 +14,15 @@ Creates or updates a top-level Storage Mover resource. ### CreateExpanded (Default) ``` -New-AzStorageMover -Name -ResourceGroupName -Location [-SubscriptionId ] - [-Description ] [-Tag ] [-DefaultProfile ] [-Confirm] [-WhatIf] +New-AzStorageMover -Name -ResourceGroupName [-SubscriptionId ] -Location + [-Description ] [-Tag ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### Create ``` -New-AzStorageMover -Name -ResourceGroupName -StorageMover - [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +New-AzStorageMover -Name -ResourceGroupName [-SubscriptionId ] + -StorageMover [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -225,4 +225,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/StorageMover/StorageMover/help/New-AzStorageMoverAzSmbFileShareEndpoint.md b/src/StorageMover/StorageMover/help/New-AzStorageMoverAzSmbFileShareEndpoint.md new file mode 100644 index 000000000000..a669b5afff70 --- /dev/null +++ b/src/StorageMover/StorageMover/help/New-AzStorageMoverAzSmbFileShareEndpoint.md @@ -0,0 +1,200 @@ +--- +external help file: Az.StorageMover-help.xml +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemoverazsmbfileshareendpoint +schema: 2.0.0 +--- + +# New-AzStorageMoverAzSmbFileShareEndpoint + +## SYNOPSIS +Creates a Smb file share endpoint resource, which represents a data transfer source or destination. + +## SYNTAX + +``` +New-AzStorageMoverAzSmbFileShareEndpoint -Name -ResourceGroupName -StorageMoverName + [-SubscriptionId ] -StorageAccountResourceId -FileShareName [-Description ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Creates a Smb file share endpoint resource, which represents a data transfer source or destination. + +## EXAMPLES + +### EXAMPLE 1 +``` +New-AzStorageMoverAzSmbFileShareEndpoint -Name "myendpoint" -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -StorageAccountResourceId $accountresourceid -FileShareName testfs -Description "New smb file share endpoint" +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description for the endpoint. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FileShareName +The name of the Azure Storage file share. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the endpoint resource. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: EndpointName + +Required: True +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 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAccountResourceId +The Azure Resource ID of the storage account that is the target destination. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 + +[https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemoverazsmbfileshareendpoint](https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemoverazsmbfileshareendpoint) + diff --git a/src/StorageMover/StorageMover/help/New-AzStorageMoverAzStorageContainerEndpoint.md b/src/StorageMover/StorageMover/help/New-AzStorageMoverAzStorageContainerEndpoint.md index 597a28affc48..3bdac2e10857 100644 --- a/src/StorageMover/StorageMover/help/New-AzStorageMoverAzStorageContainerEndpoint.md +++ b/src/StorageMover/StorageMover/help/New-AzStorageMoverAzStorageContainerEndpoint.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.StorageMover-help.xml Module Name: Az.StorageMover online version: https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemoverazstoragecontainerendpoint schema: 2.0.0 @@ -14,8 +14,8 @@ Creates an AzStorageContainer endpoint resource, which represents a data transfe ``` New-AzStorageMoverAzStorageContainerEndpoint -Name -ResourceGroupName - -StorageMoverName -BlobContainerName -StorageAccountResourceId - [-SubscriptionId ] [-Description ] [-DefaultProfile ] [-Confirm] [-WhatIf] + -StorageMoverName [-SubscriptionId ] -BlobContainerName + -StorageAccountResourceId [-Description ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` @@ -219,4 +219,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/StorageMover/StorageMover/help/New-AzStorageMoverJobDefinition.md b/src/StorageMover/StorageMover/help/New-AzStorageMoverJobDefinition.md index c15a11931b4a..ead1359aed78 100644 --- a/src/StorageMover/StorageMover/help/New-AzStorageMoverJobDefinition.md +++ b/src/StorageMover/StorageMover/help/New-AzStorageMoverJobDefinition.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.StorageMover-help.xml Module Name: Az.StorageMover online version: https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemoverjobdefinition schema: 2.0.0 @@ -15,16 +15,16 @@ Creates or updates a Job Definition resource, which contains configuration for a ### CreateExpanded (Default) ``` New-AzStorageMoverJobDefinition -Name -ProjectName -ResourceGroupName - -StorageMoverName -CopyMode -SourceName -TargetName - [-SubscriptionId ] [-AgentName ] [-Description ] [-SourceSubpath ] - [-TargetSubpath ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] + -StorageMoverName [-SubscriptionId ] -CopyMode -SourceName + -TargetName [-AgentName ] [-Description ] [-SourceSubpath ] + [-TargetSubpath ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### Create ``` New-AzStorageMoverJobDefinition -Name -ProjectName -ResourceGroupName - -StorageMoverName -JobDefinition [-SubscriptionId ] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] + -StorageMoverName [-SubscriptionId ] -JobDefinition + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -326,4 +326,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/StorageMover/StorageMover/help/New-AzStorageMoverNfsEndpoint.md b/src/StorageMover/StorageMover/help/New-AzStorageMoverNfsEndpoint.md index 81836d3dec9a..9dab2a51684b 100644 --- a/src/StorageMover/StorageMover/help/New-AzStorageMoverNfsEndpoint.md +++ b/src/StorageMover/StorageMover/help/New-AzStorageMoverNfsEndpoint.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.StorageMover-help.xml Module Name: Az.StorageMover online version: https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemovernfsendpoint schema: 2.0.0 @@ -14,8 +14,8 @@ Creates a Nfs endpoint resource, which represents a data transfer source or dest ``` New-AzStorageMoverNfsEndpoint -Name -ResourceGroupName -StorageMoverName - -Export -Host [-SubscriptionId ] [-Description ] [-NfsVersion ] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] + [-SubscriptionId ] -Host -Export [-NfsVersion ] [-Description ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -25,7 +25,7 @@ Creates a Nfs endpoint resource, which represents a data transfer source or dest ### Example 1: Create a NFS endpoint ```powershell - New-AzStorageMoverNfsEndpoint -Name myEndpoint -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Host "10.0.0.1" -Export "/" -NfsVersion NFSv3 -Description "Description" +New-AzStorageMoverNfsEndpoint -Name myEndpoint -ResourceGroupName myResourceGroup -StorageMoverName myStorageMover -Host "10.0.0.1" -Export "/" -NfsVersion NFSv3 -Description "Description" ``` ```output @@ -233,4 +233,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/StorageMover/StorageMover/help/New-AzStorageMoverProject.md b/src/StorageMover/StorageMover/help/New-AzStorageMoverProject.md index 77bb729d3e3b..b75cc2e63244 100644 --- a/src/StorageMover/StorageMover/help/New-AzStorageMoverProject.md +++ b/src/StorageMover/StorageMover/help/New-AzStorageMoverProject.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.StorageMover-help.xml Module Name: Az.StorageMover online version: https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemoverproject schema: 2.0.0 @@ -15,14 +15,14 @@ Creates or updates a Project resource, which is a logical grouping of related jo ### CreateExpanded (Default) ``` New-AzStorageMoverProject -Name -ResourceGroupName -StorageMoverName - [-SubscriptionId ] [-Description ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [-SubscriptionId ] [-Description ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### Create ``` New-AzStorageMoverProject -Name -ResourceGroupName -StorageMoverName - -Project [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [-SubscriptionId ] -Project [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` @@ -208,4 +208,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/StorageMover/StorageMover/help/New-AzStorageMoverSmbEndpoint.md b/src/StorageMover/StorageMover/help/New-AzStorageMoverSmbEndpoint.md index 3d256ac5a302..51399bb5d26e 100644 --- a/src/StorageMover/StorageMover/help/New-AzStorageMoverSmbEndpoint.md +++ b/src/StorageMover/StorageMover/help/New-AzStorageMoverSmbEndpoint.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.StorageMover-help.xml Module Name: Az.StorageMover online version: https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemoversmbendpoint schema: 2.0.0 @@ -14,8 +14,8 @@ Creates an SMB endpoint resource, which represents a data transfer source or des ``` New-AzStorageMoverSmbEndpoint -Name -ResourceGroupName -StorageMoverName - -Host -ShareName [-SubscriptionId ] [-CredentialsPasswordUri ] - [-CredentialsUsernameUri ] [-Description ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [-SubscriptionId ] -Host -ShareName [-CredentialsUsernameUri ] + [-CredentialsPasswordUri ] [-Description ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` @@ -256,4 +256,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/StorageMover/StorageMover/help/Remove-AzStorageMover.md b/src/StorageMover/StorageMover/help/Remove-AzStorageMover.md index c9fde436a739..9d0c7b87010f 100644 --- a/src/StorageMover/StorageMover/help/Remove-AzStorageMover.md +++ b/src/StorageMover/StorageMover/help/Remove-AzStorageMover.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.StorageMover-help.xml Module Name: Az.StorageMover online version: https://learn.microsoft.com/powershell/module/az.storagemover/remove-azstoragemover schema: 2.0.0 @@ -15,14 +15,13 @@ Deletes a Storage Mover resource. ### Delete (Default) ``` Remove-AzStorageMover -Name -ResourceGroupName [-SubscriptionId ] - [-DefaultProfile ] [-AsJob] [-Force] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] - [] + [-DefaultProfile ] [-Force] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentity ``` -Remove-AzStorageMover -InputObject [-DefaultProfile ] [-AsJob] [-Force] - [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +Remove-AzStorageMover -InputObject [-DefaultProfile ] [-Force] [-AsJob] + [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -71,7 +70,6 @@ Accept wildcard characters: False ### -Force - ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) @@ -221,4 +219,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/StorageMover/StorageMover/help/Remove-AzStorageMoverEndpoint.md b/src/StorageMover/StorageMover/help/Remove-AzStorageMoverEndpoint.md index 0cfccc20af17..681fbafcd5ba 100644 --- a/src/StorageMover/StorageMover/help/Remove-AzStorageMoverEndpoint.md +++ b/src/StorageMover/StorageMover/help/Remove-AzStorageMoverEndpoint.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.StorageMover-help.xml Module Name: Az.StorageMover online version: https://learn.microsoft.com/powershell/module/az.storagemover/remove-azstoragemoverendpoint schema: 2.0.0 @@ -15,14 +15,14 @@ Deletes an Endpoint resource. ### Delete (Default) ``` Remove-AzStorageMoverEndpoint -Name -ResourceGroupName -StorageMoverName - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentity ``` Remove-AzStorageMoverEndpoint -InputObject [-DefaultProfile ] [-AsJob] - [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] + [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -222,4 +222,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/StorageMover/StorageMover/help/Remove-AzStorageMoverJobDefinition.md b/src/StorageMover/StorageMover/help/Remove-AzStorageMoverJobDefinition.md index 8e92f1776869..d52061cdd32e 100644 --- a/src/StorageMover/StorageMover/help/Remove-AzStorageMoverJobDefinition.md +++ b/src/StorageMover/StorageMover/help/Remove-AzStorageMoverJobDefinition.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.StorageMover-help.xml Module Name: Az.StorageMover online version: https://learn.microsoft.com/powershell/module/az.storagemover/remove-azstoragemoverjobdefinition schema: 2.0.0 @@ -16,13 +16,13 @@ Deletes a Job Definition resource. ``` Remove-AzStorageMoverJobDefinition -Name -ProjectName -ResourceGroupName -StorageMoverName [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] - [-PassThru] [-Confirm] [-WhatIf] [] + [-PassThru] [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentity ``` Remove-AzStorageMoverJobDefinition -InputObject [-DefaultProfile ] [-AsJob] - [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] + [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -237,4 +237,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/StorageMover/StorageMover/help/Remove-AzStorageMoverProject.md b/src/StorageMover/StorageMover/help/Remove-AzStorageMoverProject.md index 06fef09dac97..aa6b26a10084 100644 --- a/src/StorageMover/StorageMover/help/Remove-AzStorageMoverProject.md +++ b/src/StorageMover/StorageMover/help/Remove-AzStorageMoverProject.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.StorageMover-help.xml Module Name: Az.StorageMover online version: https://learn.microsoft.com/powershell/module/az.storagemover/remove-azstoragemoverproject schema: 2.0.0 @@ -15,14 +15,14 @@ Deletes a Project resource. ### Delete (Default) ``` Remove-AzStorageMoverProject -Name -ResourceGroupName -StorageMoverName - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] ``` ### DeleteViaIdentity ``` Remove-AzStorageMoverProject -InputObject [-DefaultProfile ] [-AsJob] - [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] + [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -222,4 +222,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/StorageMover/StorageMover/help/Start-AzStorageMoverJobDefinition.md b/src/StorageMover/StorageMover/help/Start-AzStorageMoverJobDefinition.md index e11228593968..833fda0a645f 100644 --- a/src/StorageMover/StorageMover/help/Start-AzStorageMoverJobDefinition.md +++ b/src/StorageMover/StorageMover/help/Start-AzStorageMoverJobDefinition.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.StorageMover-help.xml Module Name: Az.StorageMover online version: https://learn.microsoft.com/powershell/module/az.storagemover/start-azstoragemoverjobdefinition schema: 2.0.0 @@ -14,15 +14,15 @@ 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 ] [-Confirm] [-WhatIf] [] +Start-AzStorageMoverJobDefinition -JobDefinitionName -ProjectName -ResourceGroupName + -StorageMoverName [-SubscriptionId ] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### StartViaIdentity ``` -Start-AzStorageMoverJobDefinition -InputObject [-DefaultProfile ] [-Confirm] - [-WhatIf] [] +Start-AzStorageMoverJobDefinition -InputObject [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -202,4 +202,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/StorageMover/StorageMover/help/Stop-AzStorageMoverJobDefinition.md b/src/StorageMover/StorageMover/help/Stop-AzStorageMoverJobDefinition.md index 32f41d7ac826..a56cc26b3345 100644 --- a/src/StorageMover/StorageMover/help/Stop-AzStorageMoverJobDefinition.md +++ b/src/StorageMover/StorageMover/help/Stop-AzStorageMoverJobDefinition.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.StorageMover-help.xml Module Name: Az.StorageMover online version: https://learn.microsoft.com/powershell/module/az.storagemover/stop-azstoragemoverjobdefinition schema: 2.0.0 @@ -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 ] [-Confirm] [-WhatIf] + -StorageMoverName [-SubscriptionId ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### StopViaIdentity ``` -Stop-AzStorageMoverJobDefinition -InputObject [-DefaultProfile ] [-Confirm] - [-WhatIf] [] +Stop-AzStorageMoverJobDefinition -InputObject [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -196,4 +196,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/StorageMover/StorageMover/help/Unregister-AzStorageMoverAgent.md b/src/StorageMover/StorageMover/help/Unregister-AzStorageMoverAgent.md index 336dac67d104..5e2dd9a64514 100644 --- a/src/StorageMover/StorageMover/help/Unregister-AzStorageMoverAgent.md +++ b/src/StorageMover/StorageMover/help/Unregister-AzStorageMoverAgent.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.StorageMover-help.xml Module Name: Az.StorageMover online version: https://learn.microsoft.com/powershell/module/az.storagemover/unregister-azstoragemoveragent schema: 2.0.0 @@ -15,14 +15,14 @@ Deletes an agent resource. ### Delete (Default) ``` Unregister-AzStorageMoverAgent -Name -ResourceGroupName -StorageMoverName - [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-Force] [-NoWait] [-PassThru] [-Confirm] - [-WhatIf] [] + [-SubscriptionId ] [-DefaultProfile ] [-Force] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] ``` ### DeleteViaIdentity ``` -Unregister-AzStorageMoverAgent -InputObject [-DefaultProfile ] [-AsJob] - [-Force] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +Unregister-AzStorageMoverAgent -InputObject [-DefaultProfile ] [-Force] + [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -71,7 +71,6 @@ Accept wildcard characters: False ### -Force - ```yaml Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) @@ -236,4 +235,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/StorageMover/StorageMover/help/Update-AzStorageMover.md b/src/StorageMover/StorageMover/help/Update-AzStorageMover.md index 7a1dfeb5f9ce..823d2fcf7375 100644 --- a/src/StorageMover/StorageMover/help/Update-AzStorageMover.md +++ b/src/StorageMover/StorageMover/help/Update-AzStorageMover.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.StorageMover-help.xml Module Name: Az.StorageMover online version: https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemover schema: 2.0.0 @@ -16,26 +16,27 @@ Properties not specified in the request body will be unchanged. ### UpdateExpanded (Default) ``` Update-AzStorageMover -Name -ResourceGroupName [-SubscriptionId ] - [-Description ] [-Tag ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [-Description ] [-Tag ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### Update ``` -Update-AzStorageMover -Name -ResourceGroupName -StorageMover - [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +Update-AzStorageMover -Name -ResourceGroupName [-SubscriptionId ] + -StorageMover [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` -### UpdateViaIdentity +### UpdateViaIdentityExpanded ``` -Update-AzStorageMover -InputObject -StorageMover - [-DefaultProfile ] [-Confirm] [-WhatIf] [] +Update-AzStorageMover -InputObject [-Description ] [-Tag ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` -### UpdateViaIdentityExpanded +### UpdateViaIdentity ``` -Update-AzStorageMover -InputObject [-Description ] [-Tag ] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] +Update-AzStorageMover -InputObject -StorageMover + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -107,7 +108,7 @@ To construct, see NOTES section for INPUTOBJECT properties and create a hash tab ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity -Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded +Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity Aliases: Required: True @@ -122,7 +123,7 @@ The name of the Storage Mover resource. ```yaml Type: System.String -Parameter Sets: Update, UpdateExpanded +Parameter Sets: UpdateExpanded, Update Aliases: StorageMoverName Required: True @@ -138,7 +139,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: Update, UpdateExpanded +Parameter Sets: UpdateExpanded, Update Aliases: Required: True @@ -169,7 +170,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: Update, UpdateExpanded +Parameter Sets: UpdateExpanded, Update Aliases: Required: False @@ -241,4 +242,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/StorageMover/StorageMover/help/Update-AzStorageMoverAgent.md b/src/StorageMover/StorageMover/help/Update-AzStorageMoverAgent.md index 67bccfb7ee1c..e176dd0b4e9e 100644 --- a/src/StorageMover/StorageMover/help/Update-AzStorageMoverAgent.md +++ b/src/StorageMover/StorageMover/help/Update-AzStorageMoverAgent.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.StorageMover-help.xml Module Name: Az.StorageMover online version: https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoveragent schema: 2.0.0 @@ -15,27 +15,27 @@ Creates or updates an Agent resource. ### UpdateExpanded (Default) ``` Update-AzStorageMoverAgent -Name -ResourceGroupName -StorageMoverName - [-SubscriptionId ] [-Description ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [-SubscriptionId ] [-Description ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### Update ``` Update-AzStorageMoverAgent -Name -ResourceGroupName -StorageMoverName - -Agent [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [-SubscriptionId ] -Agent [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` -### UpdateViaIdentity +### UpdateViaIdentityExpanded ``` -Update-AzStorageMoverAgent -InputObject -Agent - [-DefaultProfile ] [-Confirm] [-WhatIf] [] +Update-AzStorageMoverAgent -InputObject [-Description ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` -### UpdateViaIdentityExpanded +### UpdateViaIdentity ``` -Update-AzStorageMoverAgent -InputObject [-Description ] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] +Update-AzStorageMoverAgent -InputObject -Agent + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -130,7 +130,7 @@ To construct, see NOTES section for INPUTOBJECT properties and create a hash tab ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity -Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded +Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity Aliases: Required: True @@ -145,7 +145,7 @@ The name of the Agent resource. ```yaml Type: System.String -Parameter Sets: Update, UpdateExpanded +Parameter Sets: UpdateExpanded, Update Aliases: AgentName Required: True @@ -161,7 +161,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: Update, UpdateExpanded +Parameter Sets: UpdateExpanded, Update Aliases: Required: True @@ -176,7 +176,7 @@ The name of the Storage Mover resource. ```yaml Type: System.String -Parameter Sets: Update, UpdateExpanded +Parameter Sets: UpdateExpanded, Update Aliases: Required: True @@ -191,7 +191,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: Update, UpdateExpanded +Parameter Sets: UpdateExpanded, Update Aliases: Required: False @@ -248,4 +248,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/StorageMover/StorageMover/help/Update-AzStorageMoverAzSmbFileShareEndpoint.md b/src/StorageMover/StorageMover/help/Update-AzStorageMoverAzSmbFileShareEndpoint.md new file mode 100644 index 000000000000..9d1c8ff968e9 --- /dev/null +++ b/src/StorageMover/StorageMover/help/Update-AzStorageMoverAzSmbFileShareEndpoint.md @@ -0,0 +1,215 @@ +--- +external help file: Az.StorageMover-help.xml +Module Name: Az.StorageMover +online version: https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoverazsmbfileshareendpoint +schema: 2.0.0 +--- + +# Update-AzStorageMoverAzSmbFileShareEndpoint + +## SYNOPSIS +Updates properties for a SMB file share endpoint resource. +Properties not specified in the request body will be unchanged. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzStorageMoverAzSmbFileShareEndpoint -Name -ResourceGroupName + -StorageMoverName [-SubscriptionId ] [-Description ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzStorageMoverAzSmbFileShareEndpoint -InputObject [-Description ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Updates properties for a SMB file share endpoint resource. +Properties not specified in the request body will be unchanged. + +## EXAMPLES + +### EXAMPLE 1 +``` +Update-AzStorageMoverAzSmbFileShareEndpoint -Name "myendpoint" -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -Description "updated endpoint" +``` + +### EXAMPLE 2 +``` +Get-AzStorageMoverEndpoint -ResourceGroupName "myresourcegroup" -StorageMoverName "mystoragemover" -Name "myendpoint" | Update-AzStorageMoverAzSmbFileShareEndpoint -Description "updated endpoint again" +``` + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description for the endpoint. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: IStorageMoverIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the endpoint resource. + +```yaml +Type: String +Parameter Sets: UpdateExpanded +Aliases: EndpointName + +Required: True +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 +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageMoverName +The name of the Storage Mover resource. + +```yaml +Type: String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## 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 + +[https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoverazsmbfileshareendpoint](https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoverazsmbfileshareendpoint) + diff --git a/src/StorageMover/StorageMover/help/Update-AzStorageMoverAzStorageContainerEndpoint.md b/src/StorageMover/StorageMover/help/Update-AzStorageMoverAzStorageContainerEndpoint.md index 8b7dae9399f6..a3f8d7eb3fa3 100644 --- a/src/StorageMover/StorageMover/help/Update-AzStorageMoverAzStorageContainerEndpoint.md +++ b/src/StorageMover/StorageMover/help/Update-AzStorageMoverAzStorageContainerEndpoint.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.StorageMover-help.xml Module Name: Az.StorageMover online version: https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoverazstoragecontainerendpoint schema: 2.0.0 @@ -17,13 +17,13 @@ Properties not specified in the request body will be unchanged. ``` Update-AzStorageMoverAzStorageContainerEndpoint -Name -ResourceGroupName -StorageMoverName [-SubscriptionId ] [-Description ] [-DefaultProfile ] - [-Confirm] [-WhatIf] [] + [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityExpanded ``` Update-AzStorageMoverAzStorageContainerEndpoint -InputObject [-Description ] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -212,4 +212,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/StorageMover/StorageMover/help/Update-AzStorageMoverJobDefinition.md b/src/StorageMover/StorageMover/help/Update-AzStorageMoverJobDefinition.md index fc41332c5ae8..3f794b61e503 100644 --- a/src/StorageMover/StorageMover/help/Update-AzStorageMoverJobDefinition.md +++ b/src/StorageMover/StorageMover/help/Update-AzStorageMoverJobDefinition.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.StorageMover-help.xml Module Name: Az.StorageMover online version: https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoverjobdefinition schema: 2.0.0 @@ -17,27 +17,27 @@ Properties not specified in the request body will be unchanged. ``` Update-AzStorageMoverJobDefinition -Name -ProjectName -ResourceGroupName -StorageMoverName [-SubscriptionId ] [-AgentName ] [-CopyMode ] - [-Description ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] + [-Description ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### Update ``` Update-AzStorageMoverJobDefinition -Name -ProjectName -ResourceGroupName - -StorageMoverName -JobDefinition [-SubscriptionId ] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] + -StorageMoverName [-SubscriptionId ] -JobDefinition + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` -### UpdateViaIdentity +### UpdateViaIdentityExpanded ``` -Update-AzStorageMoverJobDefinition -InputObject - -JobDefinition [-DefaultProfile ] [-Confirm] [-WhatIf] +Update-AzStorageMoverJobDefinition -InputObject [-AgentName ] + [-CopyMode ] [-Description ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` -### UpdateViaIdentityExpanded +### UpdateViaIdentity ``` -Update-AzStorageMoverJobDefinition -InputObject [-AgentName ] - [-CopyMode ] [-Description ] [-DefaultProfile ] [-Confirm] [-WhatIf] +Update-AzStorageMoverJobDefinition -InputObject + -JobDefinition [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` @@ -149,7 +149,7 @@ To construct, see NOTES section for INPUTOBJECT properties and create a hash tab ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity -Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded +Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity Aliases: Required: True @@ -180,7 +180,7 @@ The name of the Job Definition resource. ```yaml Type: System.String -Parameter Sets: Update, UpdateExpanded +Parameter Sets: UpdateExpanded, Update Aliases: JobDefinitionName Required: True @@ -195,7 +195,7 @@ The name of the Project resource. ```yaml Type: System.String -Parameter Sets: Update, UpdateExpanded +Parameter Sets: UpdateExpanded, Update Aliases: Required: True @@ -211,7 +211,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: Update, UpdateExpanded +Parameter Sets: UpdateExpanded, Update Aliases: Required: True @@ -226,7 +226,7 @@ The name of the Storage Mover resource. ```yaml Type: System.String -Parameter Sets: Update, UpdateExpanded +Parameter Sets: UpdateExpanded, Update Aliases: Required: True @@ -241,7 +241,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: Update, UpdateExpanded +Parameter Sets: UpdateExpanded, Update Aliases: Required: False @@ -298,4 +298,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/StorageMover/StorageMover/help/Update-AzStorageMoverNfsEndpoint.md b/src/StorageMover/StorageMover/help/Update-AzStorageMoverNfsEndpoint.md index 6e4d985c71fe..cf911e78227f 100644 --- a/src/StorageMover/StorageMover/help/Update-AzStorageMoverNfsEndpoint.md +++ b/src/StorageMover/StorageMover/help/Update-AzStorageMoverNfsEndpoint.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.StorageMover-help.xml Module Name: Az.StorageMover online version: https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemovernfsendpoint schema: 2.0.0 @@ -16,14 +16,14 @@ Properties not specified in the request body will be unchanged. ### UpdateExpanded (Default) ``` Update-AzStorageMoverNfsEndpoint -Name -ResourceGroupName -StorageMoverName - [-SubscriptionId ] [-Description ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [-SubscriptionId ] [-Description ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityExpanded ``` Update-AzStorageMoverNfsEndpoint -InputObject [-Description ] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -212,4 +212,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/StorageMover/StorageMover/help/Update-AzStorageMoverProject.md b/src/StorageMover/StorageMover/help/Update-AzStorageMoverProject.md index e71f63b0655e..958674dd2813 100644 --- a/src/StorageMover/StorageMover/help/Update-AzStorageMoverProject.md +++ b/src/StorageMover/StorageMover/help/Update-AzStorageMoverProject.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.StorageMover-help.xml Module Name: Az.StorageMover online version: https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoverproject schema: 2.0.0 @@ -16,27 +16,27 @@ Properties not specified in the request body will be unchanged. ### UpdateExpanded (Default) ``` Update-AzStorageMoverProject -Name -ResourceGroupName -StorageMoverName - [-SubscriptionId ] [-Description ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [-SubscriptionId ] [-Description ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### Update ``` Update-AzStorageMoverProject -Name -ResourceGroupName -StorageMoverName - -Project [-SubscriptionId ] [-DefaultProfile ] [-Confirm] - [-WhatIf] [] + [-SubscriptionId ] -Project [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` -### UpdateViaIdentity +### UpdateViaIdentityExpanded ``` -Update-AzStorageMoverProject -InputObject -Project - [-DefaultProfile ] [-Confirm] [-WhatIf] [] +Update-AzStorageMoverProject -InputObject [-Description ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` -### UpdateViaIdentityExpanded +### UpdateViaIdentity ``` -Update-AzStorageMoverProject -InputObject [-Description ] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] +Update-AzStorageMoverProject -InputObject -Project + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -105,7 +105,7 @@ To construct, see NOTES section for INPUTOBJECT properties and create a hash tab ```yaml Type: Microsoft.Azure.PowerShell.Cmdlets.StorageMover.Models.IStorageMoverIdentity -Parameter Sets: UpdateViaIdentity, UpdateViaIdentityExpanded +Parameter Sets: UpdateViaIdentityExpanded, UpdateViaIdentity Aliases: Required: True @@ -120,7 +120,7 @@ The name of the Project resource. ```yaml Type: System.String -Parameter Sets: Update, UpdateExpanded +Parameter Sets: UpdateExpanded, Update Aliases: ProjectName Required: True @@ -152,7 +152,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: Update, UpdateExpanded +Parameter Sets: UpdateExpanded, Update Aliases: Required: True @@ -167,7 +167,7 @@ The name of the Storage Mover resource. ```yaml Type: System.String -Parameter Sets: Update, UpdateExpanded +Parameter Sets: UpdateExpanded, Update Aliases: Required: True @@ -182,7 +182,7 @@ The ID of the target subscription. ```yaml Type: System.String -Parameter Sets: Update, UpdateExpanded +Parameter Sets: UpdateExpanded, Update Aliases: Required: False @@ -239,4 +239,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS - diff --git a/src/StorageMover/StorageMover/help/Update-AzStorageMoverSmbEndpoint.md b/src/StorageMover/StorageMover/help/Update-AzStorageMoverSmbEndpoint.md index 4655025fb0b7..e71639888a37 100644 --- a/src/StorageMover/StorageMover/help/Update-AzStorageMoverSmbEndpoint.md +++ b/src/StorageMover/StorageMover/help/Update-AzStorageMoverSmbEndpoint.md @@ -1,5 +1,5 @@ --- -external help file: +external help file: Az.StorageMover-help.xml Module Name: Az.StorageMover online version: https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoversmbendpoint schema: 2.0.0 @@ -16,14 +16,14 @@ Properties not specified in the request body will be unchanged. ### UpdateExpanded (Default) ``` Update-AzStorageMoverSmbEndpoint -Name -ResourceGroupName -StorageMoverName - [-SubscriptionId ] [-CredentialsPasswordUri ] [-CredentialsUsernameUri ] - [-Description ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] + [-SubscriptionId ] [-CredentialsUsernameUri ] [-CredentialsPasswordUri ] + [-Description ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityExpanded ``` -Update-AzStorageMoverSmbEndpoint -InputObject [-CredentialsPasswordUri ] - [-CredentialsUsernameUri ] [-Description ] [-DefaultProfile ] [-Confirm] [-WhatIf] +Update-AzStorageMoverSmbEndpoint -InputObject [-CredentialsUsernameUri ] + [-CredentialsPasswordUri ] [-Description ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` @@ -281,4 +281,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS -