Test-AzPostgreSqlFlexibleServerMigrationNameAvailability
This cmdlet is part of a Preview module. Preview versions aren't recommended for use in production environments. For more information, see https://aka.ms/azps-refstatus .
Checks if a proposed migration name is valid and available.
Syntax
CheckExpanded (Default)
Test-AzPostgreSqlFlexibleServerMigrationNameAvailability
-ResourceGroupName <String>
-ServerName <String>
-Name <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CheckViaJsonString
Test-AzPostgreSqlFlexibleServerMigrationNameAvailability
-ResourceGroupName <String>
-ServerName <String>
-JsonString <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CheckViaJsonFilePath
Test-AzPostgreSqlFlexibleServerMigrationNameAvailability
-ResourceGroupName <String>
-ServerName <String>
-JsonFilePath <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Check
Test-AzPostgreSqlFlexibleServerMigrationNameAvailability
-ResourceGroupName <String>
-ServerName <String>
-Parameter <IMigrationNameAvailability>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CheckViaIdentityExpanded
Test-AzPostgreSqlFlexibleServerMigrationNameAvailability
-InputObject <IPostgreSqlFlexibleServerIdentity>
-Name <String>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CheckViaIdentity
Test-AzPostgreSqlFlexibleServerMigrationNameAvailability
-InputObject <IPostgreSqlFlexibleServerIdentity>
-Parameter <IMigrationNameAvailability>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Checks if a proposed migration name is valid and available.
Examples
Example 1: Check if a name is available or already used for a migration in a flexible server
Test-AzPostgreSqlFlexibleServerMigrationNameAvailability -SubscriptionId aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e -ResourceGroupName example-resource-group -ServerName server-name -Name example-migration
When name is available:
Message :
Name : example-migration
NameAvailable : True
Reason :
Type : Microsoft.DBforPostgreSQL/flexibleServers/migrations
When name is already used:
Message : N0002: There is already a migration with the same name. Please try a different one.
Name : example-migration
NameAvailable : False
Reason : AlreadyExists
Type : Microsoft.DBforPostgreSQL/flexibleServers/migrations
When name is invalid:
Message : N0001: Invalid migration-name. It should start and end with alphanumeric characters and can contain _ and - only as special characters.
Name : example~migration
NameAvailable : False
Reason : Invalid
Type : Microsoft.DBforPostgreSQL/flexibleServers/migrations
Checks if a name is available or already used for a migration in an Azure Database for PostgreSQL flexible server with resource type, migration name, server name, and subscription explicitly passed as arguments.
If subscription is not passed explicitly, it's taken from default context.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The DefaultProfile parameter is not functional.
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity
Default value: None Supports wildcards: False DontShow: False
CheckViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
CheckViaIdentity
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-JsonFilePath
Path of Json file supplied to the Check operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CheckViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-JsonString
Json string supplied to the Check operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CheckViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
Name of the migration to check for validity and availability.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CheckExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CheckViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Parameter
Availability of a migration name.
Parameter properties
Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IMigrationNameAvailability
Default value: None Supports wildcards: False DontShow: False
Parameter sets
Check
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
CheckViaIdentity
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The name of the resource group.
The name is case insensitive.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CheckExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CheckViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CheckViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Check
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ServerName
The name of the server.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CheckExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CheckViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CheckViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Check
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubscriptionId
The ID of the target subscription.
The value must be an UUID.
Parameter properties
Type: String
Default value: (Get-AzContext).Subscription.Id Supports wildcards: False DontShow: False
Parameter sets
CheckExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CheckViaJsonString
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CheckViaJsonFilePath
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Check
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IMigrationNameAvailability
Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity
Outputs
Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IMigrationNameAvailability
