Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[StorageMover] Rename SmbFileShare endpoint cmdlets #23738

Merged
merged 3 commits into from
Dec 15, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/StorageMover/StorageMover.Autorest/Az.StorageMover.psd1
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
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-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', '*'
AliasesToExport = '*'
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 = 'Azure', 'ResourceManager', 'ARM', 'PSModule', 'StorageMover'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"resourceType": "storageMovers/agents",
"apiVersion": "2023-03-01",
"apiVersion": "2023-10-01",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.storagemover"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"resourceType": "storageMovers/endpoints",
"apiVersion": "2023-03-01",
"apiVersion": "2023-10-01",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.storagemover"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"resourceType": "storageMovers/projects/jobDefinitions/jobRuns",
"apiVersion": "2023-03-01",
"apiVersion": "2023-10-01",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.storagemover"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"resourceType": "storageMovers/projects/jobDefinitions",
"apiVersion": "2023-03-01",
"apiVersion": "2023-10-01",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.storagemover"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"resourceType": "storageMovers/projects",
"apiVersion": "2023-03-01",
"apiVersion": "2023-10-01",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.storagemover"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"resourceType": "storageMovers",
"apiVersion": "2023-03-01",
"apiVersion": "2023-10-01",
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.storagemover"
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,10 @@ To create the parameters described below, construct a hash table containing the
.Link
https://learn.microsoft.com/powershell/module/az.storagemover/new-azstoragemoversmbfileshareendpoint
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

help link also need change.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

#>
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')]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,10 @@ INPUTOBJECT<IStorageMoverIdentity>: Identity Parameter
.Link
https://learn.microsoft.com/powershell/module/az.storagemover/update-azstoragemoversmbfileshareendpoint
#>
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")]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We might should add a test case to make sure the old name still work.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

test case added

param(
[Parameter(ParameterSetName='UpdateExpanded', Mandatory)]
[Alias('EndpointName')]
Expand Down
14 changes: 7 additions & 7 deletions src/StorageMover/StorageMover.Autorest/docs/Az.StorageMover.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ Gets a Project resource.
### [New-AzStorageMover](New-AzStorageMover.md)
Creates or updates a top-level Storage Mover resource.

### [New-AzStorageMoverAzSmbFileShareEndpoint](New-AzStorageMoverAzSmbFileShareEndpoint.md)
Creates a Smb file share endpoint resource, which represents a data transfer source or destination.

### [New-AzStorageMoverAzStorageContainerEndpoint](New-AzStorageMoverAzStorageContainerEndpoint.md)
Creates an AzStorageContainer endpoint resource, which represents a data transfer source or destination.

Expand All @@ -47,9 +50,6 @@ Creates or updates a Project resource, which is a logical grouping of related jo
### [New-AzStorageMoverSmbEndpoint](New-AzStorageMoverSmbEndpoint.md)
Creates an SMB endpoint resource, which represents a data transfer source or destination.

### [New-AzStorageMoverSmbFileShareEndpoint](New-AzStorageMoverSmbFileShareEndpoint.md)
Creates a Smb file share endpoint resource, which represents a data transfer source or destination.

### [Remove-AzStorageMover](Remove-AzStorageMover.md)
Deletes a Storage Mover resource.

Expand Down Expand Up @@ -78,6 +78,10 @@ Properties not specified in the request body will be unchanged.
### [Update-AzStorageMoverAgent](Update-AzStorageMoverAgent.md)
Creates or updates an Agent resource.

### [Update-AzStorageMoverAzSmbFileShareEndpoint](Update-AzStorageMoverAzSmbFileShareEndpoint.md)
Updates properties for a SMB file share endpoint resource.
Properties not specified in the request body will be unchanged.

### [Update-AzStorageMoverAzStorageContainerEndpoint](Update-AzStorageMoverAzStorageContainerEndpoint.md)
Updates properties for an AzStorageContainer endpoint resource.
Properties not specified in the request body will be unchanged.
Expand All @@ -98,7 +102,3 @@ Properties not specified in the request body will be unchanged.
Updates properties for a SMB endpoint resource.
Properties not specified in the request body will be unchanged.

### [Update-AzStorageMoverSmbFileShareEndpoint](Update-AzStorageMoverSmbFileShareEndpoint.md)
Updates properties for a SMB file share endpoint resource.
Properties not specified in the request body will be unchanged.

18 changes: 0 additions & 18 deletions src/StorageMover/StorageMover.Autorest/docs/Get-AzStorageMover.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,23 +227,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## NOTES

ALIASES

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 <IStorageMoverIdentity>`: Identity Parameter
- `[AgentName <String>]`: The name of the Agent resource.
- `[EndpointName <String>]`: The name of the Endpoint resource.
- `[Id <String>]`: Resource identity path
- `[JobDefinitionName <String>]`: The name of the Job Definition resource.
- `[JobRunName <String>]`: The name of the Job Run resource.
- `[ProjectName <String>]`: The name of the Project resource.
- `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive.
- `[StorageMoverName <String>]`: The name of the Storage Mover resource.
- `[SubscriptionId <String>]`: The ID of the target subscription.

## RELATED LINKS

Original file line number Diff line number Diff line change
Expand Up @@ -206,23 +206,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## NOTES

ALIASES

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 <IStorageMoverIdentity>`: Identity Parameter
- `[AgentName <String>]`: The name of the Agent resource.
- `[EndpointName <String>]`: The name of the Endpoint resource.
- `[Id <String>]`: Resource identity path
- `[JobDefinitionName <String>]`: The name of the Job Definition resource.
- `[JobRunName <String>]`: The name of the Job Run resource.
- `[ProjectName <String>]`: The name of the Project resource.
- `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive.
- `[StorageMoverName <String>]`: The name of the Storage Mover resource.
- `[SubscriptionId <String>]`: The ID of the target subscription.

## RELATED LINKS

Original file line number Diff line number Diff line change
Expand Up @@ -209,23 +209,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## NOTES

ALIASES

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 <IStorageMoverIdentity>`: Identity Parameter
- `[AgentName <String>]`: The name of the Agent resource.
- `[EndpointName <String>]`: The name of the Endpoint resource.
- `[Id <String>]`: Resource identity path
- `[JobDefinitionName <String>]`: The name of the Job Definition resource.
- `[JobRunName <String>]`: The name of the Job Run resource.
- `[ProjectName <String>]`: The name of the Project resource.
- `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive.
- `[StorageMoverName <String>]`: The name of the Storage Mover resource.
- `[SubscriptionId <String>]`: The ID of the target subscription.

## RELATED LINKS

Original file line number Diff line number Diff line change
Expand Up @@ -224,23 +224,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## NOTES

ALIASES

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 <IStorageMoverIdentity>`: Identity Parameter
- `[AgentName <String>]`: The name of the Agent resource.
- `[EndpointName <String>]`: The name of the Endpoint resource.
- `[Id <String>]`: Resource identity path
- `[JobDefinitionName <String>]`: The name of the Job Definition resource.
- `[JobRunName <String>]`: The name of the Job Run resource.
- `[ProjectName <String>]`: The name of the Project resource.
- `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive.
- `[StorageMoverName <String>]`: The name of the Storage Mover resource.
- `[SubscriptionId <String>]`: The ID of the target subscription.

## RELATED LINKS

Original file line number Diff line number Diff line change
Expand Up @@ -280,23 +280,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## NOTES

ALIASES

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 <IStorageMoverIdentity>`: Identity Parameter
- `[AgentName <String>]`: The name of the Agent resource.
- `[EndpointName <String>]`: The name of the Endpoint resource.
- `[Id <String>]`: Resource identity path
- `[JobDefinitionName <String>]`: The name of the Job Definition resource.
- `[JobRunName <String>]`: The name of the Job Run resource.
- `[ProjectName <String>]`: The name of the Project resource.
- `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive.
- `[StorageMoverName <String>]`: The name of the Storage Mover resource.
- `[SubscriptionId <String>]`: The ID of the target subscription.

## RELATED LINKS

Original file line number Diff line number Diff line change
Expand Up @@ -197,23 +197,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## NOTES

ALIASES

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 <IStorageMoverIdentity>`: Identity Parameter
- `[AgentName <String>]`: The name of the Agent resource.
- `[EndpointName <String>]`: The name of the Endpoint resource.
- `[Id <String>]`: Resource identity path
- `[JobDefinitionName <String>]`: The name of the Job Definition resource.
- `[JobRunName <String>]`: The name of the Job Run resource.
- `[ProjectName <String>]`: The name of the Project resource.
- `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive.
- `[StorageMoverName <String>]`: The name of the Storage Mover resource.
- `[SubscriptionId <String>]`: The ID of the target subscription.

## RELATED LINKS

19 changes: 0 additions & 19 deletions src/StorageMover/StorageMover.Autorest/docs/New-AzStorageMover.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,24 +224,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## NOTES

ALIASES

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.


`STORAGEMOVER <IStorageMover>`: The Storage Mover resource, which is a container for a group of Agents, Projects, and Endpoints.
- `Location <String>`: The geo-location where the resource lives
- `[Tag <ITrackedResourceTags>]`: Resource tags.
- `[(Any) <String>]`: This indicates any property can be added to this object.
- `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC).
- `[SystemDataCreatedBy <String>]`: The identity that created the resource.
- `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource.
- `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC)
- `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource.
- `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource.
- `[Description <String>]`: A description for the Storage Mover.

## RELATED LINKS

Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ online version: https://learn.microsoft.com/powershell/module/az.storagemover/ne
schema: 2.0.0
---

# New-AzStorageMoverSmbFileShareEndpoint
# New-AzStorageMoverAzSmbFileShareEndpoint

## SYNOPSIS
Creates a Smb file share endpoint resource, which represents a data transfer source or destination.

## SYNTAX

```
New-AzStorageMoverSmbFileShareEndpoint -Name <String> -ResourceGroupName <String> -StorageMoverName <String>
New-AzStorageMoverAzSmbFileShareEndpoint -Name <String> -ResourceGroupName <String> -StorageMoverName <String>
-FileShareName <String> -StorageAccountResourceId <String> [-SubscriptionId <String>] [-Description <String>]
[-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]
```
Expand All @@ -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
Expand All @@ -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

Expand Down Expand Up @@ -220,5 +220,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

ALIASES

New-AzStorageMoverSmbFileShareEndpoint

## RELATED LINKS

Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## NOTES

ALIASES

## RELATED LINKS

Original file line number Diff line number Diff line change
Expand Up @@ -325,27 +325,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## NOTES

ALIASES

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.


`JOBDEFINITION <IJobDefinition>`: The Job Definition resource.
- `CopyMode <CopyMode>`: Strategy to use for copy.
- `SourceName <String>`: The name of the source Endpoint.
- `TargetName <String>`: The name of the target Endpoint.
- `[SystemDataCreatedAt <DateTime?>]`: The timestamp of resource creation (UTC).
- `[SystemDataCreatedBy <String>]`: The identity that created the resource.
- `[SystemDataCreatedByType <CreatedByType?>]`: The type of identity that created the resource.
- `[SystemDataLastModifiedAt <DateTime?>]`: The timestamp of resource last modification (UTC)
- `[SystemDataLastModifiedBy <String>]`: The identity that last modified the resource.
- `[SystemDataLastModifiedByType <CreatedByType?>]`: The type of identity that last modified the resource.
- `[AgentName <String>]`: Name of the Agent to assign for new Job Runs of this Job Definition.
- `[Description <String>]`: A description for the Job Definition.
- `[SourceSubpath <String>]`: The subpath to use when reading from the source Endpoint.
- `[TargetSubpath <String>]`: The subpath to use when writing to the target Endpoint.

## RELATED LINKS

Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## NOTES

ALIASES

## RELATED LINKS

Loading
Loading