diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/.gitattributes b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/.gitattributes new file mode 100644 index 000000000000..2125666142eb --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/.gitattributes @@ -0,0 +1 @@ +* text=auto \ No newline at end of file diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/.gitignore b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/.gitignore new file mode 100644 index 000000000000..6ec158bd9768 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/.gitignore @@ -0,0 +1,16 @@ +bin +obj +.vs +generated +internal +exports +tools +test/*-TestResults.xml +license.txt +/*.ps1 +/*.psd1 +/*.ps1xml +/*.psm1 +/*.snk +/*.csproj +/*.nuspec \ No newline at end of file diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/Properties/AssemblyInfo.cs b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/Properties/AssemblyInfo.cs new file mode 100644 index 000000000000..143e1f6aa418 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/Properties/AssemblyInfo.cs @@ -0,0 +1,27 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the Apache License, Version 2.0 (the ""License""); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// http://www.apache.org/licenses/LICENSE-2.0 +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an ""AS IS"" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code +// is regenerated. + +using System; +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Runtime.InteropServices; + +[assembly: System.Reflection.AssemblyCompanyAttribute("Microsoft")] +[assembly: System.Reflection.AssemblyCopyrightAttribute("Copyright © Microsoft")] +[assembly: System.Reflection.AssemblyProductAttribute("Microsoft Azure PowerShell")] +[assembly: System.Reflection.AssemblyTitleAttribute("Microsoft Azure PowerShell - PostgreSqlFlexibleServer")] +[assembly: System.Reflection.AssemblyFileVersionAttribute("0.1.0")] +[assembly: System.Reflection.AssemblyVersionAttribute("0.1.0")] +[assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)] +[assembly: System.CLSCompliantAttribute(false)] + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/README.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/README.md new file mode 100644 index 000000000000..26462cbfd7cc --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/README.md @@ -0,0 +1,84 @@ + +# Az.PostgreSqlFlexibleServer +This directory contains the PowerShell module for the PostgreSqlFlexibleServer service. + +--- +## Info +- Modifiable: yes +- Generated: all +- Committed: yes +- Packaged: yes + +--- +## Detail +This module was primarily generated via [AutoRest](https://github.com/Azure/autorest) using the [PowerShell](https://github.com/Azure/autorest.powershell) extension. + +## Module Requirements +- [Az.Accounts module](https://www.powershellgallery.com/packages/Az.Accounts/), version 2.7.5 or greater + +## Authentication +AutoRest does not generate authentication code for the module. Authentication is handled via Az.Accounts by altering the HTTP payload before it is sent. + +## Development +For information on how to develop for `Az.PostgreSqlFlexibleServer`, see [how-to.md](how-to.md). + + +# Az.PostgreSQLFlexibleServer + +This directory contains the PowerShell module for the Azure Database for PostgreSQL Flexible Server service. + +## AutoRest Configuration + +> see [autorest](https://aka.ms/autorest) + +```yaml +# pin the swagger version by using the commit id instead of branch name +commit: be31c7768b25795ee6aadd24783100254499c845 +repo: https://github.com/Azure/azure-rest-api-specs +require: +# readme.azure.noprofile.md is the common configuration file + - $(this-folder)/../../readme.azure.noprofile.md + - $(repo)/specification/postgresql/resource-manager/readme.md + +# For new RP, the version is 0.1.0 +module-version: 0.1.0 +# Normally, title is the service name +title: PostgreSQLFlexibleServer +subject-prefix: PostgreSQLFlexibleServer +input-file: + - $(repo)/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2025-08-01/openapi.json + +use: + - "@autorest/powershell@latest" + +directive: + # Fix SecureString type conversion issues in BackupStoreDetails + # AutoRest generates direct string to SecureString casts which are invalid + # Replace invalid cast with proper SecureString creation helper method + - from: BackupStoreDetails.json.cs + where: $ + transform: | + return $.replace( + /\(System\.Security\.SecureString\)\(__t\.ToString\(\)\)/g, + 'ConvertToSecureString(__t.ToString())' + ).replace( + /(namespace [^{]+\{[\s\S]*?)(internal BackupStoreDetails)/, + '$1\n private static System.Security.SecureString ConvertToSecureString(string value)\n {\n if (string.IsNullOrEmpty(value)) return null;\n var secureString = new System.Security.SecureString();\n foreach (char c in value)\n {\n secureString.AppendChar(c);\n }\n secureString.MakeReadOnly();\n return secureString;\n }\n\n $2' + ); + + # Following are common directives which are normally required in all the RPs + # 1. Remove the unexpanded parameter set + # 2. For New-* cmdlets, ViaIdentity is not required + # Following two directives are v4 specific + - where: + variant: ^(Create|Update)(?!.*?(Expanded|JsonFilePath|JsonString)) + remove: true + - where: + variant: ^CreateViaIdentity$|^CreateViaIdentityExpanded$ + remove: true + + # Remove the set-* cmdlet + - where: + verb: Set + remove: true +``` diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers-administrators.json b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers-administrators.json new file mode 100644 index 000000000000..aaba3a2a5090 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers-administrators.json @@ -0,0 +1,95 @@ +{ + "resourceType": "flexibleServers/administrators", + "apiVersion": "2025-08-01", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver" + }, + "commands": [ + { + "name": "Get-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra", + "description": "Gets information about a server administrator associated to a Microsoft Entra principal.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/administrators/{objectId}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleserveradministratorsmicrosoftentra" + }, + "parameterSets": [ + { + "parameters": [ + "-ObjectId ", + "-ResourceGroupName ", + "-ServerName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Gets information about a server administrator associated to a Microsoft Entra principal.", + "parameters": [ + { + "name": "-ObjectId", + "value": "[Path.objectId]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-ServerName", + "value": "[Path.serverName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Remove-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra", + "description": "Deletes an existing server administrator associated to a Microsoft Entra principal.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/administrators/{objectId}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/remove-azpostgresqlflexibleserveradministratorsmicrosoftentra" + }, + "parameterSets": [ + { + "parameters": [ + "-ObjectId ", + "-ResourceGroupName ", + "-ServerName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Deletes an existing server administrator associated to a Microsoft Entra principal.", + "parameters": [ + { + "name": "-ObjectId", + "value": "[Path.objectId]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-ServerName", + "value": "[Path.serverName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + } + ] +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers-advancedThreatProtectionSettings.json b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers-advancedThreatProtectionSettings.json new file mode 100644 index 000000000000..13e912ede113 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers-advancedThreatProtectionSettings.json @@ -0,0 +1,47 @@ +{ + "resourceType": "flexibleServers/advancedThreatProtectionSettings", + "apiVersion": "2025-08-01", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver" + }, + "commands": [ + { + "name": "Get-AzPostgreSqlFlexibleServerAdvancedThreatProtectionSetting", + "description": "Gets state of advanced threat protection settings for a server.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/advancedThreatProtectionSettings/{threatProtectionName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleserveradvancedthreatprotectionsetting" + }, + "parameterSets": [ + { + "parameters": [ + "-ResourceGroupName ", + "-ServerName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Gets state of advanced threat protection settings for a server.", + "parameters": [ + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-ServerName", + "value": "[Path.serverName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + } + ] +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers-backups.json b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers-backups.json new file mode 100644 index 000000000000..d38dfd2f2a06 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers-backups.json @@ -0,0 +1,95 @@ +{ + "resourceType": "flexibleServers/backups", + "apiVersion": "2025-08-01", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver" + }, + "commands": [ + { + "name": "Get-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand", + "description": "Gets information of an on demand backup, given its name.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/backups/{backupName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleserverbackupsautomaticandondemand" + }, + "parameterSets": [ + { + "parameters": [ + "-BackupName ", + "-ResourceGroupName ", + "-ServerName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Gets information of an on demand backup, given its name.", + "parameters": [ + { + "name": "-BackupName", + "value": "[Path.backupName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-ServerName", + "value": "[Path.serverName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Remove-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand", + "description": "Deletes a specific backup, given its name.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/backups/{backupName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/remove-azpostgresqlflexibleserverbackupsautomaticandondemand" + }, + "parameterSets": [ + { + "parameters": [ + "-BackupName ", + "-ResourceGroupName ", + "-ServerName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Deletes a specific backup, given its name.", + "parameters": [ + { + "name": "-BackupName", + "value": "[Path.backupName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-ServerName", + "value": "[Path.serverName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + } + ] +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers-configurations.json b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers-configurations.json new file mode 100644 index 000000000000..51c60b68d16b --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers-configurations.json @@ -0,0 +1,52 @@ +{ + "resourceType": "flexibleServers/configurations", + "apiVersion": "2025-08-01", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver" + }, + "commands": [ + { + "name": "Get-AzPostgreSqlFlexibleServerConfiguration", + "description": "Gets information about a specific configuration (also known as server parameter) of a server.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/configurations/{configurationName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleserverconfiguration" + }, + "parameterSets": [ + { + "parameters": [ + "-Name ", + "-ResourceGroupName ", + "-ServerName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Gets information about a specific configuration (also known as server parameter) of a server.", + "parameters": [ + { + "name": "-Name", + "value": "[Path.configurationName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-ServerName", + "value": "[Path.serverName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + } + ] +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers-databases.json b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers-databases.json new file mode 100644 index 000000000000..b587727ab562 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers-databases.json @@ -0,0 +1,95 @@ +{ + "resourceType": "flexibleServers/databases", + "apiVersion": "2025-08-01", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver" + }, + "commands": [ + { + "name": "Get-AzPostgreSqlFlexibleServerDatabase", + "description": "Gets information about an existing database.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/databases/{databaseName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleserverdatabase" + }, + "parameterSets": [ + { + "parameters": [ + "-Name ", + "-ResourceGroupName ", + "-ServerName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Gets information about an existing database.", + "parameters": [ + { + "name": "-Name", + "value": "[Path.databaseName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-ServerName", + "value": "[Path.serverName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Remove-AzPostgreSqlFlexibleServerDatabase", + "description": "Deletes an existing database.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/databases/{databaseName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/remove-azpostgresqlflexibleserverdatabase" + }, + "parameterSets": [ + { + "parameters": [ + "-Name ", + "-ResourceGroupName ", + "-ServerName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Deletes an existing database.", + "parameters": [ + { + "name": "-Name", + "value": "[Path.databaseName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-ServerName", + "value": "[Path.serverName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + } + ] +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers-firewallRules.json b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers-firewallRules.json new file mode 100644 index 000000000000..861cbb74fbb5 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers-firewallRules.json @@ -0,0 +1,95 @@ +{ + "resourceType": "flexibleServers/firewallRules", + "apiVersion": "2025-08-01", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver" + }, + "commands": [ + { + "name": "Get-AzPostgreSqlFlexibleServerFirewallRule", + "description": "Gets information about a firewall rule in a server.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/firewallRules/{firewallRuleName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleserverfirewallrule" + }, + "parameterSets": [ + { + "parameters": [ + "-Name ", + "-ResourceGroupName ", + "-ServerName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Gets information about a firewall rule in a server.", + "parameters": [ + { + "name": "-Name", + "value": "[Path.firewallRuleName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-ServerName", + "value": "[Path.serverName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Remove-AzPostgreSqlFlexibleServerFirewallRule", + "description": "Deletes an existing firewall rule.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/firewallRules/{firewallRuleName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/remove-azpostgresqlflexibleserverfirewallrule" + }, + "parameterSets": [ + { + "parameters": [ + "-Name ", + "-ResourceGroupName ", + "-ServerName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Deletes an existing firewall rule.", + "parameters": [ + { + "name": "-Name", + "value": "[Path.firewallRuleName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-ServerName", + "value": "[Path.serverName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + } + ] +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers-ltrBackupOperations.json b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers-ltrBackupOperations.json new file mode 100644 index 000000000000..e7bed53905f6 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers-ltrBackupOperations.json @@ -0,0 +1,52 @@ +{ + "resourceType": "flexibleServers/ltrBackupOperations", + "apiVersion": "2025-08-01", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver" + }, + "commands": [ + { + "name": "Get-AzPostgreSqlFlexibleServerBackupsLongTermRetention", + "description": "Gets the results of a long retention backup operation for a server.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/ltrBackupOperations/{backupName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleserverbackupslongtermretention" + }, + "parameterSets": [ + { + "parameters": [ + "-BackupName ", + "-ResourceGroupName ", + "-ServerName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Gets the results of a long retention backup operation for a server.", + "parameters": [ + { + "name": "-BackupName", + "value": "[Path.backupName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-ServerName", + "value": "[Path.serverName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + } + ] +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers-migrations.json b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers-migrations.json new file mode 100644 index 000000000000..109778f174f0 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers-migrations.json @@ -0,0 +1,95 @@ +{ + "resourceType": "flexibleServers/migrations", + "apiVersion": "2025-08-01", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver" + }, + "commands": [ + { + "name": "Get-AzPostgreSqlFlexibleServerMigration", + "description": "Gets information about a migration.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/migrations/{migrationName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleservermigration" + }, + "parameterSets": [ + { + "parameters": [ + "-Name ", + "-ResourceGroupName ", + "-ServerName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Gets information about a migration.", + "parameters": [ + { + "name": "-Name", + "value": "[Path.migrationName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-ServerName", + "value": "[Path.serverName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Stop-AzPostgreSqlFlexibleServerMigration", + "description": "Cancels an active migration.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/migrations/{migrationName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/stop-azpostgresqlflexibleservermigration" + }, + "parameterSets": [ + { + "parameters": [ + "-Name ", + "-ResourceGroupName ", + "-ServerName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Cancels an active migration.", + "parameters": [ + { + "name": "-Name", + "value": "[Path.migrationName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-ServerName", + "value": "[Path.serverName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + } + ] +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers-tuningOptions.json b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers-tuningOptions.json new file mode 100644 index 000000000000..f0f72c412410 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers-tuningOptions.json @@ -0,0 +1,52 @@ +{ + "resourceType": "flexibleServers/tuningOptions", + "apiVersion": "2025-08-01", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver" + }, + "commands": [ + { + "name": "Get-AzPostgreSqlFlexibleServerTuningOption", + "description": "Gets the tuning options of a server.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/tuningOptions/{tuningOption}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleservertuningoption" + }, + "parameterSets": [ + { + "parameters": [ + "-ResourceGroupName ", + "-ServerName ", + "[-SubscriptionId ]", + "-TuningOption " + ] + } + ] + }, + "examples": [ + { + "description": "Gets the tuning options of a server.", + "parameters": [ + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-ServerName", + "value": "[Path.serverName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + }, + { + "name": "-TuningOption", + "value": "[Path.tuningOption]" + } + ] + } + ] + } + ] +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers-virtualendpoints.json b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers-virtualendpoints.json new file mode 100644 index 000000000000..49421ea6919c --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers-virtualendpoints.json @@ -0,0 +1,95 @@ +{ + "resourceType": "flexibleServers/virtualendpoints", + "apiVersion": "2025-08-01", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver" + }, + "commands": [ + { + "name": "Get-AzPostgreSqlFlexibleServerVirtualEndpoint", + "description": "Gets information about a pair of virtual endpoints.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/virtualendpoints/{virtualEndpointName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleservervirtualendpoint" + }, + "parameterSets": [ + { + "parameters": [ + "-Name ", + "-ResourceGroupName ", + "-ServerName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Gets information about a pair of virtual endpoints.", + "parameters": [ + { + "name": "-Name", + "value": "[Path.virtualEndpointName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-ServerName", + "value": "[Path.serverName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Remove-AzPostgreSqlFlexibleServerVirtualEndpoint", + "description": "Deletes a pair of virtual endpoints.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/virtualendpoints/{virtualEndpointName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/remove-azpostgresqlflexibleservervirtualendpoint" + }, + "parameterSets": [ + { + "parameters": [ + "-Name ", + "-ResourceGroupName ", + "-ServerName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Deletes a pair of virtual endpoints.", + "parameters": [ + { + "name": "-Name", + "value": "[Path.virtualEndpointName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-ServerName", + "value": "[Path.serverName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + } + ] +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers.json b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers.json new file mode 100644 index 000000000000..d47b961f9c0e --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/UX/Microsoft.DBforPostgreSQL/flexibleServers.json @@ -0,0 +1,161 @@ +{ + "resourceType": "flexibleServers", + "apiVersion": "2025-08-01", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver" + }, + "commands": [ + { + "name": "Get-AzPostgreSqlFlexibleServer", + "description": "Gets information about an existing server.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleserver" + }, + "parameterSets": [ + { + "parameters": [ + "-Name ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Gets information about an existing server.", + "parameters": [ + { + "name": "-Name", + "value": "[Path.serverName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Remove-AzPostgreSqlFlexibleServer", + "description": "Deletes or drops an existing server.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/remove-azpostgresqlflexibleserver" + }, + "parameterSets": [ + { + "parameters": [ + "-Name ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Deletes or drops an existing server.", + "parameters": [ + { + "name": "-Name", + "value": "[Path.serverName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Start-AzPostgreSqlFlexibleServer", + "description": "Starts a stopped server.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/start", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/start-azpostgresqlflexibleserver" + }, + "parameterSets": [ + { + "parameters": [ + "-Name ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Starts a stopped server.", + "parameters": [ + { + "name": "-Name", + "value": "[Path.serverName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + }, + { + "name": "Stop-AzPostgreSqlFlexibleServer", + "description": "Stops a server.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/stop", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/stop-azpostgresqlflexibleserver" + }, + "parameterSets": [ + { + "parameters": [ + "-Name ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Stops a server.", + "parameters": [ + { + "name": "-Name", + "value": "[Path.serverName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + } + ] +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/custom/Az.PostgreSqlFlexibleServer.custom.psm1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/custom/Az.PostgreSqlFlexibleServer.custom.psm1 new file mode 100644 index 000000000000..055b4eaabaed --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/custom/Az.PostgreSqlFlexibleServer.custom.psm1 @@ -0,0 +1,17 @@ +# region Generated + # Load the private module dll + $null = Import-Module -PassThru -Name (Join-Path $PSScriptRoot '..\bin\Az.PostgreSqlFlexibleServer.private.dll') + + # Load the internal module + $internalModulePath = Join-Path $PSScriptRoot '..\internal\Az.PostgreSqlFlexibleServer.internal.psm1' + if(Test-Path $internalModulePath) { + $null = Import-Module -Name $internalModulePath + } + + # Export nothing to clear implicit exports + Export-ModuleMember + + # Export script cmdlets + Get-ChildItem -Path $PSScriptRoot -Recurse -Include '*.ps1' -File | ForEach-Object { . $_.FullName } + Export-ModuleMember -Function (Get-ScriptCmdlet -ScriptFolder $PSScriptRoot) -Alias (Get-ScriptCmdlet -ScriptFolder $PSScriptRoot -AsAlias) +# endregion diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/custom/README.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/custom/README.md new file mode 100644 index 000000000000..8c340c7b3b0e --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/custom/README.md @@ -0,0 +1,41 @@ +# Custom +This directory contains custom implementation for non-generated cmdlets for the `Az.PostgreSqlFlexibleServer` module. Both scripts (`.ps1`) and C# files (`.cs`) can be implemented here. They will be used during the build process in `build-module.ps1`, and create cmdlets into the `..\exports` folder. The only generated file into this folder is the `Az.PostgreSqlFlexibleServer.custom.psm1`. This file should not be modified. + +## Info +- Modifiable: yes +- Generated: partial +- Committed: yes +- Packaged: yes + +## Details +For `Az.PostgreSqlFlexibleServer` to use custom cmdlets, it does this two different ways. We **highly recommend** creating script cmdlets, as they are easier to write and allow access to the other exported cmdlets. C# cmdlets *cannot access exported cmdlets*. + +For C# cmdlets, they are compiled with the rest of the generated low-level cmdlets into the `./bin/Az.PostgreSqlFlexibleServer.private.dll`. The names of the cmdlets (methods) and files must follow the `[cmdletName]_[variantName]` syntax used for generated cmdlets. The `variantName` is used as the `ParameterSetName`, so use something appropriate that doesn't clash with already created variant or parameter set names. You cannot use the `ParameterSetName` property in the `Parameter` attribute on C# cmdlets. Each cmdlet must be separated into variants using the same pattern as seen in the `generated/cmdlets` folder. + +For script cmdlets, these are loaded via the `Az.PostgreSqlFlexibleServer.custom.psm1`. Then, during the build process, this module is loaded and processed in the same manner as the C# cmdlets. The fundamental difference is the script cmdlets use the `ParameterSetName` attribute and C# cmdlets do not. To create a script cmdlet variant of a generated cmdlet, simply decorate all parameters in the script with the new `ParameterSetName` in the `Parameter` attribute. This will appropriately treat each parameter set as a separate variant when processed to be exported during the build. + +## Purpose +This allows the modules to have cmdlets that were not defined in the REST specification. It also allows combining logic using generated cmdlets. This is a level of customization beyond what can be done using the [readme configuration options](https://github.com/Azure/autorest/blob/master/docs/powershell/options.md) that are currently available. These custom cmdlets are then referenced by the cmdlets created at build-time in the `..\exports` folder. + +## Usage +The easiest way currently to start developing custom cmdlets is to copy an existing cmdlet. For C# cmdlets, copy one from the `generated/cmdlets` folder. For script cmdlets, build the project using `build-module.ps1` and copy one of the scripts from the `..\exports` folder. After that, if you want to add new parameter sets, follow the guidelines in the `Details` section above. For implementing a new cmdlets, at minimum, please keep these parameters: +- Break +- DefaultProfile +- HttpPipelineAppend +- HttpPipelinePrepend +- Proxy +- ProxyCredential +- ProxyUseDefaultCredentials + +These provide functionality to our HTTP pipeline and other useful features. In script, you can forward these parameters using `$PSBoundParameters` to the other cmdlets you're calling within `Az.PostgreSqlFlexibleServer`. For C#, follow the usage seen in the `ProcessRecordAsync` method. + +### Attributes +For processing the cmdlets, we've created some additional attributes: +- `Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.DescriptionAttribute` + - Used in C# cmdlets to provide a high-level description of the cmdlet. This is propagated to reference documentation via [help comments](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) in the exported scripts. +- `Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.DoNotExportAttribute` + - Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.PostgreSqlFlexibleServer`. +- `Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.InternalExportAttribute` + - Used in C# cmdlets to route exported cmdlets to the `..\internal`, which are *not exposed* by `Az.PostgreSqlFlexibleServer`. For more information, see [README.md](..\internal/README.md) in the `..\internal` folder. +- `Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.ProfileAttribute` + - Used in C# and script cmdlets to define which Azure profiles the cmdlet supports. This is only supported for Azure (`--azure`) modules. \ No newline at end of file diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Az.PostgreSqlFlexibleServer.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Az.PostgreSqlFlexibleServer.md new file mode 100644 index 000000000000..760bd00378e2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Az.PostgreSqlFlexibleServer.md @@ -0,0 +1,156 @@ +--- +Module Name: Az.PostgreSqlFlexibleServer +Module Guid: e75cbd8f-66fd-4c28-b7e1-a3e0e39d299e +Download Help Link: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver +Help Version: 1.0.0.0 +Locale: en-US +--- + +# Az.PostgreSqlFlexibleServer Module +## Description +Microsoft Azure PowerShell: PostgreSqlFlexibleServer cmdlets + +## Az.PostgreSqlFlexibleServer Cmdlets +### [Get-AzPostgreSqlFlexibleServer](Get-AzPostgreSqlFlexibleServer.md) +Gets information about an existing server. + +### [Get-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra](Get-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md) +Gets information about a server administrator associated to a Microsoft Entra principal. + +### [Get-AzPostgreSqlFlexibleServerAdvancedThreatProtectionSetting](Get-AzPostgreSqlFlexibleServerAdvancedThreatProtectionSetting.md) +Gets state of advanced threat protection settings for a server. + +### [Get-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand](Get-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand.md) +Gets information of an on demand backup, given its name. + +### [Get-AzPostgreSqlFlexibleServerBackupsLongTermRetention](Get-AzPostgreSqlFlexibleServerBackupsLongTermRetention.md) +Gets the results of a long retention backup operation for a server. + +### [Get-AzPostgreSqlFlexibleServerCapabilitiesByLocation](Get-AzPostgreSqlFlexibleServerCapabilitiesByLocation.md) +Lists the capabilities available in a given location for a specific subscription. + +### [Get-AzPostgreSqlFlexibleServerCapabilitiesByServer](Get-AzPostgreSqlFlexibleServerCapabilitiesByServer.md) +Lists the capabilities available for a given server. + +### [Get-AzPostgreSqlFlexibleServerCapturedLog](Get-AzPostgreSqlFlexibleServerCapturedLog.md) +Lists all captured logs for download in a server. + +### [Get-AzPostgreSqlFlexibleServerConfiguration](Get-AzPostgreSqlFlexibleServerConfiguration.md) +Gets information about a specific configuration (also known as server parameter) of a server. + +### [Get-AzPostgreSqlFlexibleServerDatabase](Get-AzPostgreSqlFlexibleServerDatabase.md) +Gets information about an existing database. + +### [Get-AzPostgreSqlFlexibleServerFirewallRule](Get-AzPostgreSqlFlexibleServerFirewallRule.md) +Gets information about a firewall rule in a server. + +### [Get-AzPostgreSqlFlexibleServerMigration](Get-AzPostgreSqlFlexibleServerMigration.md) +Gets information about a migration. + +### [Get-AzPostgreSqlFlexibleServerPrivateDnsZoneSuffix](Get-AzPostgreSqlFlexibleServerPrivateDnsZoneSuffix.md) +Gets the private DNS zone suffix. + +### [Get-AzPostgreSqlFlexibleServerQuotaUsage](Get-AzPostgreSqlFlexibleServerQuotaUsage.md) +Get quota usages at specified location in a given subscription. + +### [Get-AzPostgreSqlFlexibleServerReplica](Get-AzPostgreSqlFlexibleServerReplica.md) +Lists all read replicas of a server. + +### [Get-AzPostgreSqlFlexibleServerTuningOption](Get-AzPostgreSqlFlexibleServerTuningOption.md) +Gets the tuning options of a server. + +### [Get-AzPostgreSqlFlexibleServerTuningOptionRecommendation](Get-AzPostgreSqlFlexibleServerTuningOptionRecommendation.md) +Lists available object recommendations. + +### [Get-AzPostgreSqlFlexibleServerVirtualEndpoint](Get-AzPostgreSqlFlexibleServerVirtualEndpoint.md) +Gets information about a pair of virtual endpoints. + +### [Get-AzPostgreSqlFlexibleServerVirtualNetworkSubnetUsage](Get-AzPostgreSqlFlexibleServerVirtualNetworkSubnetUsage.md) +Lists the virtual network subnet usage for a given virtual network. + +### [New-AzPostgreSqlFlexibleServer](New-AzPostgreSqlFlexibleServer.md) +Create a new server. + +### [New-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra](New-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md) +Create a new server administrator associated to a Microsoft Entra principal. + +### [New-AzPostgreSqlFlexibleServerDatabase](New-AzPostgreSqlFlexibleServerDatabase.md) +Create a new database. + +### [New-AzPostgreSqlFlexibleServerFirewallRule](New-AzPostgreSqlFlexibleServerFirewallRule.md) +Create a new firewall rule or create an existing firewall rule. + +### [New-AzPostgreSqlFlexibleServerMigration](New-AzPostgreSqlFlexibleServerMigration.md) +Create a new migration. + +### [New-AzPostgreSqlFlexibleServerThreatProtectionSetting](New-AzPostgreSqlFlexibleServerThreatProtectionSetting.md) +Create a server's Advanced Threat Protection settings. + +### [New-AzPostgreSqlFlexibleServerVirtualEndpoint](New-AzPostgreSqlFlexibleServerVirtualEndpoint.md) +Create a pair of virtual endpoints for a server. + +### [Remove-AzPostgreSqlFlexibleServer](Remove-AzPostgreSqlFlexibleServer.md) +Deletes or drops an existing server. + +### [Remove-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra](Remove-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md) +Deletes an existing server administrator associated to a Microsoft Entra principal. + +### [Remove-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand](Remove-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand.md) +Deletes a specific backup, given its name. + +### [Remove-AzPostgreSqlFlexibleServerDatabase](Remove-AzPostgreSqlFlexibleServerDatabase.md) +Deletes an existing database. + +### [Remove-AzPostgreSqlFlexibleServerFirewallRule](Remove-AzPostgreSqlFlexibleServerFirewallRule.md) +Deletes an existing firewall rule. + +### [Remove-AzPostgreSqlFlexibleServerVirtualEndpoint](Remove-AzPostgreSqlFlexibleServerVirtualEndpoint.md) +Deletes a pair of virtual endpoints. + +### [Restart-AzPostgreSqlFlexibleServer](Restart-AzPostgreSqlFlexibleServer.md) +Restarts PostgreSQL database engine in a server. + +### [Start-AzPostgreSqlFlexibleServer](Start-AzPostgreSqlFlexibleServer.md) +Starts a stopped server. + +### [Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention](Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention.md) +Initiates a long term retention backup. + +### [Stop-AzPostgreSqlFlexibleServer](Stop-AzPostgreSqlFlexibleServer.md) +Stops a server. + +### [Stop-AzPostgreSqlFlexibleServerMigration](Stop-AzPostgreSqlFlexibleServerMigration.md) +Cancels an active migration. + +### [Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite](Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite.md) +Performs all checks required for a long term retention backup operation to succeed. + +### [Test-AzPostgreSqlFlexibleServerMigrationNameAvailability](Test-AzPostgreSqlFlexibleServerMigrationNameAvailability.md) +Checks if a proposed migration name is valid and available. + +### [Test-AzPostgreSqlFlexibleServerNameAvailability](Test-AzPostgreSqlFlexibleServerNameAvailability.md) +Check the availability of name for resource + +### [Test-AzPostgreSqlFlexibleServerNameAvailabilityGlobally](Test-AzPostgreSqlFlexibleServerNameAvailabilityGlobally.md) +Checks the validity and availability of the given name, to assign it to a new server or to use it as the base name of a new pair of virtual endpoints. + +### [Update-AzPostgreSqlFlexibleServer](Update-AzPostgreSqlFlexibleServer.md) +Update a new server. + +### [Update-AzPostgreSqlFlexibleServerConfiguration](Update-AzPostgreSqlFlexibleServerConfiguration.md) +Update the value assigned to a specific modifiable configuration (also known as server parameter) of a server. + +### [Update-AzPostgreSqlFlexibleServerDatabase](Update-AzPostgreSqlFlexibleServerDatabase.md) +Update a new database. + +### [Update-AzPostgreSqlFlexibleServerFirewallRule](Update-AzPostgreSqlFlexibleServerFirewallRule.md) +Update a new firewall rule or update an existing firewall rule. + +### [Update-AzPostgreSqlFlexibleServerMigration](Update-AzPostgreSqlFlexibleServerMigration.md) +Update an existing migration. +The request body can contain one to many of the mutable properties present in the migration definition. +Certain property update initiate migration state transitions. + +### [Update-AzPostgreSqlFlexibleServerVirtualEndpoint](Update-AzPostgreSqlFlexibleServerVirtualEndpoint.md) +Update a pair of virtual endpoints for a server. + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServer.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServer.md new file mode 100644 index 000000000000..1fa570684b8d --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServer.md @@ -0,0 +1,159 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleserver +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServer + +## SYNOPSIS +Gets information about an existing server. + +## SYNTAX + +### List (Default) +``` +Get-AzPostgreSqlFlexibleServer [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzPostgreSqlFlexibleServer -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlFlexibleServer -InputObject [-DefaultProfile ] + [] +``` + +### List1 +``` +Get-AzPostgreSqlFlexibleServer -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets information about an existing server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +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 server. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ServerName + +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. +The value must be an UUID. + +```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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IServer + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md new file mode 100644 index 000000000000..715558e32433 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md @@ -0,0 +1,191 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleserveradministratorsmicrosoftentra +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra + +## SYNOPSIS +Gets information about a server administrator associated to a Microsoft Entra principal. + +## SYNTAX + +### List (Default) +``` +Get-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra -ObjectId -ResourceGroupName + -ServerName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra -InputObject + [-DefaultProfile ] [] +``` + +### GetViaIdentityFlexibleServer +``` +Get-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra + -FlexibleServerInputObject -ObjectId + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets information about a server administrator associated to a Microsoft Entra principal. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentityFlexibleServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ObjectId +Object identifier of the Microsoft Entra principal. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityFlexibleServer +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 +``` + +### -ServerName +The name of the server. + +```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. +The value must be an UUID. + +```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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IAdministratorMicrosoftEntra + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerAdvancedThreatProtectionSetting.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerAdvancedThreatProtectionSetting.md new file mode 100644 index 000000000000..5baf8e41aa9d --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerAdvancedThreatProtectionSetting.md @@ -0,0 +1,154 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleserveradvancedthreatprotectionsetting +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerAdvancedThreatProtectionSetting + +## SYNOPSIS +Gets state of advanced threat protection settings for a server. + +## SYNTAX + +### Get (Default) +``` +Get-AzPostgreSqlFlexibleServerAdvancedThreatProtectionSetting -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlFlexibleServerAdvancedThreatProtectionSetting -InputObject + [-DefaultProfile ] [] +``` + +### List +``` +Get-AzPostgreSqlFlexibleServerAdvancedThreatProtectionSetting -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets state of advanced threat protection settings for a server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentity +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: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```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. +The value must be an UUID. + +```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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IAdvancedThreatProtectionSettingsModel + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand.md new file mode 100644 index 000000000000..d3a7d9fa7661 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand.md @@ -0,0 +1,191 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleserverbackupsautomaticandondemand +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand + +## SYNOPSIS +Gets information of an on demand backup, given its name. + +## SYNTAX + +### List (Default) +``` +Get-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand -BackupName -ResourceGroupName + -ServerName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand -InputObject + [-DefaultProfile ] [] +``` + +### GetViaIdentityFlexibleServer +``` +Get-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand -BackupName + -FlexibleServerInputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Gets information of an on demand backup, given its name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -BackupName +Name of the backup. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityFlexibleServer +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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentityFlexibleServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentity +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: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```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. +The value must be an UUID. + +```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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IBackupAutomaticAndOnDemand + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerBackupsLongTermRetention.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerBackupsLongTermRetention.md new file mode 100644 index 000000000000..b0652b2065af --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerBackupsLongTermRetention.md @@ -0,0 +1,191 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleserverbackupslongtermretention +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerBackupsLongTermRetention + +## SYNOPSIS +Gets the results of a long retention backup operation for a server. + +## SYNTAX + +### List (Default) +``` +Get-AzPostgreSqlFlexibleServerBackupsLongTermRetention -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzPostgreSqlFlexibleServerBackupsLongTermRetention -BackupName -ResourceGroupName + -ServerName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlFlexibleServerBackupsLongTermRetention -InputObject + [-DefaultProfile ] [] +``` + +### GetViaIdentityFlexibleServer +``` +Get-AzPostgreSqlFlexibleServerBackupsLongTermRetention -BackupName + -FlexibleServerInputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Gets the results of a long retention backup operation for a server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -BackupName +The name of the backup. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityFlexibleServer +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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentityFlexibleServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentity +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: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```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. +The value must be an UUID. + +```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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IBackupsLongTermRetentionOperation + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerCapabilitiesByLocation.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerCapabilitiesByLocation.md new file mode 100644 index 000000000000..9307492a63d3 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerCapabilitiesByLocation.md @@ -0,0 +1,108 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleservercapabilitiesbylocation +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerCapabilitiesByLocation + +## SYNOPSIS +Lists the capabilities available in a given location for a specific subscription. + +## SYNTAX + +``` +Get-AzPostgreSqlFlexibleServerCapabilitiesByLocation -LocationName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Lists the capabilities available in a given location for a specific subscription. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -LocationName +The name of the location. + +```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. +The value must be an UUID. + +```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 +``` + +### 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 + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.ICapability + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerCapabilitiesByServer.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerCapabilitiesByServer.md new file mode 100644 index 000000000000..bd4f4aa12570 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerCapabilitiesByServer.md @@ -0,0 +1,124 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleservercapabilitiesbyserver +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerCapabilitiesByServer + +## SYNOPSIS +Lists the capabilities available for a given server. + +## SYNTAX + +``` +Get-AzPostgreSqlFlexibleServerCapabilitiesByServer -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Lists the capabilities available for a given server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -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 +``` + +### -ServerName +The name of 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 +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```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 +``` + +### 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 + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.ICapability + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerCapturedLog.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerCapturedLog.md new file mode 100644 index 000000000000..de579dc83d3f --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerCapturedLog.md @@ -0,0 +1,124 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleservercapturedlog +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerCapturedLog + +## SYNOPSIS +Lists all captured logs for download in a server. + +## SYNTAX + +``` +Get-AzPostgreSqlFlexibleServerCapturedLog -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Lists all captured logs for download in a server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -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 +``` + +### -ServerName +The name of 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 +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```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 +``` + +### 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 + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.ICapturedLog + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerConfiguration.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerConfiguration.md new file mode 100644 index 000000000000..39a89ae84881 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerConfiguration.md @@ -0,0 +1,190 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleserverconfiguration +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerConfiguration + +## SYNOPSIS +Gets information about a specific configuration (also known as server parameter) of a server. + +## SYNTAX + +### List (Default) +``` +Get-AzPostgreSqlFlexibleServerConfiguration -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzPostgreSqlFlexibleServerConfiguration -Name -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlFlexibleServerConfiguration -InputObject + [-DefaultProfile ] [] +``` + +### GetViaIdentityFlexibleServer +``` +Get-AzPostgreSqlFlexibleServerConfiguration -FlexibleServerInputObject + -Name [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets information about a specific configuration (also known as server parameter) of a server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentityFlexibleServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the configuration (also known as server parameter). + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityFlexibleServer +Aliases: ConfigurationName + +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 +``` + +### -ServerName +The name of the server. + +```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. +The value must be an UUID. + +```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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IConfiguration + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerDatabase.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerDatabase.md new file mode 100644 index 000000000000..f151420624b4 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerDatabase.md @@ -0,0 +1,191 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleserverdatabase +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerDatabase + +## SYNOPSIS +Gets information about an existing database. + +## SYNTAX + +### List (Default) +``` +Get-AzPostgreSqlFlexibleServerDatabase -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzPostgreSqlFlexibleServerDatabase -Name -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlFlexibleServerDatabase -InputObject + [-DefaultProfile ] [] +``` + +### GetViaIdentityFlexibleServer +``` +Get-AzPostgreSqlFlexibleServerDatabase -FlexibleServerInputObject + -Name [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets information about an existing database. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentityFlexibleServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the database (case-sensitive). +Exact database names can be retrieved by getting the list of all existing databases in a server. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityFlexibleServer +Aliases: DatabaseName + +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 +``` + +### -ServerName +The name of the server. + +```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. +The value must be an UUID. + +```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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IDatabase + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerFirewallRule.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerFirewallRule.md new file mode 100644 index 000000000000..f3dd8c41a7db --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerFirewallRule.md @@ -0,0 +1,190 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleserverfirewallrule +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerFirewallRule + +## SYNOPSIS +Gets information about a firewall rule in a server. + +## SYNTAX + +### List (Default) +``` +Get-AzPostgreSqlFlexibleServerFirewallRule -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzPostgreSqlFlexibleServerFirewallRule -Name -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlFlexibleServerFirewallRule -InputObject + [-DefaultProfile ] [] +``` + +### GetViaIdentityFlexibleServer +``` +Get-AzPostgreSqlFlexibleServerFirewallRule -FlexibleServerInputObject + -Name [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets information about a firewall rule in a server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentityFlexibleServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the firewall rule. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityFlexibleServer +Aliases: FirewallRuleName + +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 +``` + +### -ServerName +The name of the server. + +```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. +The value must be an UUID. + +```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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IFirewallRule + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerMigration.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerMigration.md new file mode 100644 index 000000000000..6af12259fc13 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerMigration.md @@ -0,0 +1,208 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleservermigration +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerMigration + +## SYNOPSIS +Gets information about a migration. + +## SYNTAX + +### List (Default) +``` +Get-AzPostgreSqlFlexibleServerMigration -ResourceGroupName -ServerName + [-SubscriptionId ] [-MigrationListFilter ] [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzPostgreSqlFlexibleServerMigration -Name -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlFlexibleServerMigration -InputObject + [-DefaultProfile ] [] +``` + +### GetViaIdentityFlexibleServer +``` +Get-AzPostgreSqlFlexibleServerMigration -FlexibleServerInputObject + -Name [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets information about a migration. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentityFlexibleServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MigrationListFilter +Migration list filter. +Indicates if the request should retrieve only active migrations or all migrations. +Defaults to Active. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of migration. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityFlexibleServer +Aliases: MigrationName + +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 +``` + +### -ServerName +The name of the server. + +```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. +The value must be an UUID. + +```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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IMigration + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerPrivateDnsZoneSuffix.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerPrivateDnsZoneSuffix.md new file mode 100644 index 000000000000..53e4de553c09 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerPrivateDnsZoneSuffix.md @@ -0,0 +1,108 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleserverprivatednszonesuffix +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerPrivateDnsZoneSuffix + +## SYNOPSIS +Gets the private DNS zone suffix. + +## SYNTAX + +``` +Get-AzPostgreSqlFlexibleServerPrivateDnsZoneSuffix [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Gets the private DNS zone suffix. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -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 + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerQuotaUsage.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerQuotaUsage.md new file mode 100644 index 000000000000..27a8ce34da8c --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerQuotaUsage.md @@ -0,0 +1,108 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleserverquotausage +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerQuotaUsage + +## SYNOPSIS +Get quota usages at specified location in a given subscription. + +## SYNTAX + +``` +Get-AzPostgreSqlFlexibleServerQuotaUsage -LocationName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get quota usages at specified location in a given subscription. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -LocationName +The name of the location. + +```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. +The value must be an UUID. + +```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 +``` + +### 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 + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IQuotaUsage + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerReplica.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerReplica.md new file mode 100644 index 000000000000..0e689e807c90 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerReplica.md @@ -0,0 +1,124 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleserverreplica +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerReplica + +## SYNOPSIS +Lists all read replicas of a server. + +## SYNTAX + +``` +Get-AzPostgreSqlFlexibleServerReplica -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +Lists all read replicas of a server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -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 +``` + +### -ServerName +The name of 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 +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```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 +``` + +### 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 + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IServer + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerTuningOption.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerTuningOption.md new file mode 100644 index 000000000000..6af745f51939 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerTuningOption.md @@ -0,0 +1,190 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleservertuningoption +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerTuningOption + +## SYNOPSIS +Gets the tuning options of a server. + +## SYNTAX + +### List (Default) +``` +Get-AzPostgreSqlFlexibleServerTuningOption -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzPostgreSqlFlexibleServerTuningOption -ResourceGroupName -ServerName + -TuningOption [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlFlexibleServerTuningOption -InputObject + [-DefaultProfile ] [] +``` + +### GetViaIdentityFlexibleServer +``` +Get-AzPostgreSqlFlexibleServerTuningOption -FlexibleServerInputObject + -TuningOption [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets the tuning options of a server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentityFlexibleServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentity +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: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```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. +The value must be an UUID. + +```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 +``` + +### -TuningOption +The name of the tuning option. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityFlexibleServer +Aliases: + +Required: True +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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.ITuningOptions + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerTuningOptionRecommendation.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerTuningOptionRecommendation.md new file mode 100644 index 000000000000..567cd9adc41f --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerTuningOptionRecommendation.md @@ -0,0 +1,156 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleservertuningoptionrecommendation +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerTuningOptionRecommendation + +## SYNOPSIS +Lists available object recommendations. + +## SYNTAX + +``` +Get-AzPostgreSqlFlexibleServerTuningOptionRecommendation -ResourceGroupName -ServerName + -TuningOption [-SubscriptionId ] [-RecommendationType ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Lists available object recommendations. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -RecommendationType +Recommendations list filter. +Retrieves recommendations based on type. + +```yaml +Type: System.String +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 +``` + +### -ServerName +The name of 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 +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```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 +``` + +### -TuningOption +The name of the tuning option. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +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 + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IObjectRecommendation + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerVirtualEndpoint.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerVirtualEndpoint.md new file mode 100644 index 000000000000..74484dfa28b0 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerVirtualEndpoint.md @@ -0,0 +1,190 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleservervirtualendpoint +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerVirtualEndpoint + +## SYNOPSIS +Gets information about a pair of virtual endpoints. + +## SYNTAX + +### List (Default) +``` +Get-AzPostgreSqlFlexibleServerVirtualEndpoint -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzPostgreSqlFlexibleServerVirtualEndpoint -Name -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlFlexibleServerVirtualEndpoint -InputObject + [-DefaultProfile ] [] +``` + +### GetViaIdentityFlexibleServer +``` +Get-AzPostgreSqlFlexibleServerVirtualEndpoint -FlexibleServerInputObject + -Name [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets information about a pair of virtual endpoints. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentityFlexibleServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Base name of the virtual endpoints. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityFlexibleServer +Aliases: VirtualEndpointName + +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 +``` + +### -ServerName +The name of the server. + +```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. +The value must be an UUID. + +```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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IVirtualEndpoint + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerVirtualNetworkSubnetUsage.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerVirtualNetworkSubnetUsage.md new file mode 100644 index 000000000000..60b98adef02c --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Get-AzPostgreSqlFlexibleServerVirtualNetworkSubnetUsage.md @@ -0,0 +1,222 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleservervirtualnetworksubnetusage +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerVirtualNetworkSubnetUsage + +## SYNOPSIS +Lists the virtual network subnet usage for a given virtual network. + +## SYNTAX + +### ListExpanded (Default) +``` +Get-AzPostgreSqlFlexibleServerVirtualNetworkSubnetUsage -LocationName [-SubscriptionId ] + [-VirtualNetworkArmResourceId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### List +``` +Get-AzPostgreSqlFlexibleServerVirtualNetworkSubnetUsage -LocationName + -Parameter [-SubscriptionId ] [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +### ListViaJsonFilePath +``` +Get-AzPostgreSqlFlexibleServerVirtualNetworkSubnetUsage -LocationName -JsonFilePath + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### ListViaJsonString +``` +Get-AzPostgreSqlFlexibleServerVirtualNetworkSubnetUsage -LocationName -JsonString + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Lists the virtual network subnet usage for a given virtual network. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -JsonFilePath +Path of Json file supplied to the List operation + +```yaml +Type: System.String +Parameter Sets: ListViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the List operation + +```yaml +Type: System.String +Parameter Sets: ListViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationName +The name of the location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Virtual network subnet usage parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IVirtualNetworkSubnetUsageParameter +Parameter Sets: List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```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 +``` + +### -VirtualNetworkArmResourceId +Virtual network resource id. + +```yaml +Type: System.String +Parameter Sets: ListExpanded +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.PostgreSqlFlexibleServer.Models.IVirtualNetworkSubnetUsageParameter + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IVirtualNetworkSubnetUsageModel + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/New-AzPostgreSqlFlexibleServer.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/New-AzPostgreSqlFlexibleServer.md new file mode 100644 index 000000000000..acdebc88fb31 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/New-AzPostgreSqlFlexibleServer.md @@ -0,0 +1,830 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/new-azpostgresqlflexibleserver +schema: 2.0.0 +--- + +# New-AzPostgreSqlFlexibleServer + +## SYNOPSIS +Create a new server. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzPostgreSqlFlexibleServer -Name -ResourceGroupName -Location + [-SubscriptionId ] [-AdministratorLogin ] [-AdministratorLoginPassword ] + [-AuthConfigActiveDirectoryAuth ] [-AuthConfigPasswordAuth ] [-AuthConfigTenantId ] + [-AvailabilityZone ] [-BackupGeoRedundantBackup ] [-BackupRetentionDay ] + [-ClusterDefaultDatabaseName ] [-ClusterSize ] [-CreateMode ] + [-DataEncryptionGeoBackupKeyUri ] [-DataEncryptionGeoBackupUserAssignedIdentityId ] + [-DataEncryptionPrimaryKeyUri ] [-DataEncryptionPrimaryUserAssignedIdentityId ] + [-DataEncryptionType ] [-EnableSystemAssignedIdentity] [-HighAvailabilityMode ] + [-HighAvailabilityStandbyAvailabilityZone ] [-IdentityPrincipalId ] + [-NetworkDelegatedSubnetResourceId ] [-NetworkPrivateDnsZoneArmResourceId ] + [-NetworkPublicNetworkAccess ] [-PointInTimeUtc ] [-ReplicationRole ] + [-SkuName ] [-SkuTier ] [-SourceServerResourceId ] [-StorageAutoGrow ] + [-StorageIop ] [-StorageSizeGb ] [-StorageThroughput ] [-StorageTier ] + [-StorageType ] [-Tag ] [-UserAssignedIdentity ] [-Version ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonFilePath +``` +New-AzPostgreSqlFlexibleServer -Name -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaJsonString +``` +New-AzPostgreSqlFlexibleServer -Name -ResourceGroupName -JsonString + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Create a new server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AdministratorLogin +Name of the login designated as the first password based administrator assigned to your instance of PostgreSQL. +Must be specified the first time that you enable password based authentication on a server. +Once set to a given value, it cannot be changed for the rest of the life of a server. +If you disable password based authentication on a server which had it enabled, this password based role isn't deleted. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdministratorLoginPassword +Password assigned to the administrator login. +As long as password authentication is enabled, this password can be changed at any time. + +```yaml +Type: System.Security.SecureString +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -AuthConfigActiveDirectoryAuth +Indicates if the server supports Microsoft Entra authentication. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthConfigPasswordAuth +Indicates if the server supports password based authentication. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthConfigTenantId +Identifier of the tenant of the delegated resource. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvailabilityZone +Availability zone of a server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupGeoRedundantBackup +Indicates if the server is configured to create geographically redundant backups. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupRetentionDay +Backup retention days for the server. + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterDefaultDatabaseName +Default database name for the elastic cluster. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterSize +Number of nodes assigned to the elastic cluster. + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreateMode +Creation mode of a new server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataEncryptionGeoBackupKeyUri +Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a server that is configured to support geographically redundant backups. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataEncryptionGeoBackupUserAssignedIdentityId +Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a server that is configured to support geographically redundant backups. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataEncryptionPrimaryKeyUri +URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataEncryptionPrimaryUserAssignedIdentityId +Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the primary storage associated to a server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataEncryptionType +Data encryption type used by a server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +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 +``` + +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighAvailabilityMode +High availability mode for a server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighAvailabilityStandbyAvailabilityZone +Availability zone associated to the standby server created when high availability is set to SameZone or ZoneRedundant. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityPrincipalId +Identifier of the object of the service principal associated to the user assigned managed identity. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +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 server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkDelegatedSubnetResourceId +Resource identifier of the delegated subnet. +Required during creation of a new server, in case you want the server to be integrated into your own virtual network. +For an update operation, you only have to provide this property if you want to change the value assigned for the private DNS zone. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkPrivateDnsZoneArmResourceId +Identifier of the private DNS zone. +Required during creation of a new server, in case you want the server to be integrated into your own virtual network. +For an update operation, you only have to provide this property if you want to change the value assigned for the private DNS zone. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkPublicNetworkAccess +Indicates if public network access is enabled or not. +This is only supported for servers that are not integrated into a virtual network which is owned and provided by customer when server is deployed. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +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 +``` + +### -PointInTimeUtc +Creation time (in ISO8601 format) of the backup which you want to restore in the new server. +It's required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', or 'ReviveDropped'. + +```yaml +Type: System.DateTime +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationRole +Role of the server in a replication set. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +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 +``` + +### -SkuName +Name by which is known a given compute size assigned to a server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +Tier of the compute assigned to a server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceServerResourceId +Identifier of the server to be used as the source of the new server. +Required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', 'Replica', or 'ReviveDropped'. +This property is returned only when the target server is a read replica. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAutoGrow +Flag to enable or disable the automatic growth of storage size of a server when available space is nearing zero and conditions allow for automatically growing storage size. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageIop +Maximum IOPS supported for storage. +Required when type of storage is PremiumV2_LRS or UltraSSD_LRS. + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageSizeGb +Size of storage assigned to a server. + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageThroughput +Maximum throughput supported for storage. +Required when type of storage is PremiumV2_LRS or UltraSSD_LRS. + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageTier +Storage tier of a server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageType +Type of storage assigned to a server. +Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. +If not specified, it defaults to Premium_LRS. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```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 +``` + +### -UserAssignedIdentity +The array of user assigned identities associated with the resource. +The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.' + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Major version of PostgreSQL database engine. + +```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 + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IServer + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/New-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/New-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md new file mode 100644 index 000000000000..fa014e2a1ad1 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/New-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md @@ -0,0 +1,317 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/new-azpostgresqlflexibleserveradministratorsmicrosoftentra +schema: 2.0.0 +--- + +# New-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra + +## SYNOPSIS +Create a new server administrator associated to a Microsoft Entra principal. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra -ObjectId -ResourceGroupName + -ServerName [-SubscriptionId ] [-PrincipalName ] [-PrincipalType ] + [-TenantId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaIdentityFlexibleServerExpanded +``` +New-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra + -FlexibleServerInputObject -ObjectId [-PrincipalName ] + [-PrincipalType ] [-TenantId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### CreateViaJsonFilePath +``` +New-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra -ObjectId -ResourceGroupName + -ServerName -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonString +``` +New-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra -ObjectId -ResourceGroupName + -ServerName -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Create a new server administrator associated to a Microsoft Entra principal. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +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 +``` + +### -ObjectId +Object identifier of the Microsoft Entra principal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalName +Name of the Microsoft Entra principal. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalType +Type of Microsoft Entra principal to which the server administrator is associated. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +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: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +Identifier of the tenant in which the Microsoft Entra principal exists. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IAdministratorMicrosoftEntra + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/New-AzPostgreSqlFlexibleServerDatabase.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/New-AzPostgreSqlFlexibleServerDatabase.md new file mode 100644 index 000000000000..ac07c6ecd8de --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/New-AzPostgreSqlFlexibleServerDatabase.md @@ -0,0 +1,301 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/new-azpostgresqlflexibleserverdatabase +schema: 2.0.0 +--- + +# New-AzPostgreSqlFlexibleServerDatabase + +## SYNOPSIS +Create a new database. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzPostgreSqlFlexibleServerDatabase -Name -ResourceGroupName -ServerName + [-SubscriptionId ] [-Charset ] [-Collation ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentityFlexibleServerExpanded +``` +New-AzPostgreSqlFlexibleServerDatabase -FlexibleServerInputObject + -Name [-Charset ] [-Collation ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonFilePath +``` +New-AzPostgreSqlFlexibleServerDatabase -Name -ResourceGroupName -ServerName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### CreateViaJsonString +``` +New-AzPostgreSqlFlexibleServerDatabase -Name -ResourceGroupName -ServerName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Create a new database. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -Charset +Character set of the database. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Collation +Collation of the database. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the database (case-sensitive). +Exact database names can be retrieved by getting the list of all existing databases in a server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DatabaseName + +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 +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IDatabase + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/New-AzPostgreSqlFlexibleServerFirewallRule.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/New-AzPostgreSqlFlexibleServerFirewallRule.md new file mode 100644 index 000000000000..498bc777ce5d --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/New-AzPostgreSqlFlexibleServerFirewallRule.md @@ -0,0 +1,302 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/new-azpostgresqlflexibleserverfirewallrule +schema: 2.0.0 +--- + +# New-AzPostgreSqlFlexibleServerFirewallRule + +## SYNOPSIS +Create a new firewall rule or create an existing firewall rule. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzPostgreSqlFlexibleServerFirewallRule -Name -ResourceGroupName -ServerName + -EndIPAddress -StartIPAddress [-SubscriptionId ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentityFlexibleServerExpanded +``` +New-AzPostgreSqlFlexibleServerFirewallRule -FlexibleServerInputObject + -Name -EndIPAddress -StartIPAddress [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonFilePath +``` +New-AzPostgreSqlFlexibleServerFirewallRule -Name -ResourceGroupName -ServerName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### CreateViaJsonString +``` +New-AzPostgreSqlFlexibleServerFirewallRule -Name -ResourceGroupName -ServerName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Create a new firewall rule or create an existing firewall rule. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -EndIPAddress +IP address defining the end of the range of addresses of a firewall rule. +Must be expressed in IPv4 format. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the firewall rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: FirewallRuleName + +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 +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartIPAddress +IP address defining the start of the range of addresses of a firewall rule. +Must be expressed in IPv4 format. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IFirewallRule + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/New-AzPostgreSqlFlexibleServerMigration.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/New-AzPostgreSqlFlexibleServerMigration.md new file mode 100644 index 000000000000..514b0bd03239 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/New-AzPostgreSqlFlexibleServerMigration.md @@ -0,0 +1,643 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/new-azpostgresqlflexibleservermigration +schema: 2.0.0 +--- + +# New-AzPostgreSqlFlexibleServerMigration + +## SYNOPSIS +Create a new migration. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzPostgreSqlFlexibleServerMigration -Name -ResourceGroupName -ServerName + -Location [-SubscriptionId ] [-AdminCredentialsSourceServerPassword ] + [-AdminCredentialsTargetServerPassword ] [-Cancel ] + [-DbsToCancelMigrationOn ] [-DbsToMigrate ] [-DbsToTriggerCutoverOn ] + [-MigrateRole ] [-MigrationInstanceResourceId ] [-MigrationMode ] + [-MigrationOption ] [-MigrationWindowEndTimeInUtc ] + [-MigrationWindowStartTimeInUtc ] [-OverwriteDbsInTarget ] + [-SecretParameterSourceServerUsername ] [-SecretParameterTargetServerUsername ] + [-SetupLogicalReplicationOnSourceDbIfNeeded ] [-SourceDbServerFullyQualifiedDomainName ] + [-SourceDbServerResourceId ] [-SourceType ] [-SslMode ] + [-StartDataMigration ] [-Tag ] [-TargetDbServerFullyQualifiedDomainName ] + [-TriggerCutover ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentityFlexibleServerExpanded +``` +New-AzPostgreSqlFlexibleServerMigration -FlexibleServerInputObject + -Name -Location [-AdminCredentialsSourceServerPassword ] + [-AdminCredentialsTargetServerPassword ] [-Cancel ] + [-DbsToCancelMigrationOn ] [-DbsToMigrate ] [-DbsToTriggerCutoverOn ] + [-MigrateRole ] [-MigrationInstanceResourceId ] [-MigrationMode ] + [-MigrationOption ] [-MigrationWindowEndTimeInUtc ] + [-MigrationWindowStartTimeInUtc ] [-OverwriteDbsInTarget ] + [-SecretParameterSourceServerUsername ] [-SecretParameterTargetServerUsername ] + [-SetupLogicalReplicationOnSourceDbIfNeeded ] [-SourceDbServerFullyQualifiedDomainName ] + [-SourceDbServerResourceId ] [-SourceType ] [-SslMode ] + [-StartDataMigration ] [-Tag ] [-TargetDbServerFullyQualifiedDomainName ] + [-TriggerCutover ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonFilePath +``` +New-AzPostgreSqlFlexibleServerMigration -Name -ResourceGroupName -ServerName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaJsonString +``` +New-AzPostgreSqlFlexibleServerMigration -Name -ResourceGroupName -ServerName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Create a new migration. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AdminCredentialsSourceServerPassword +Password for the user of the source server. + +```yaml +Type: System.Security.SecureString +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminCredentialsTargetServerPassword +Password for the user of the target server. + +```yaml +Type: System.Security.SecureString +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Cancel +Indicates if cancel must be triggered for the entire migration. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DbsToCancelMigrationOn +When you want to trigger cancel for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array. + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DbsToMigrate +Names of databases to migrate. + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DbsToTriggerCutoverOn +When you want to trigger cutover for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array. + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +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, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrateRole +Indicates if roles and permissions must be migrated. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationInstanceResourceId +Identifier of the private endpoint migration instance. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationMode +Mode used to perform the migration: Online or Offline. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationOption +Supported option for a migration. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationWindowEndTimeInUtc +End time (UTC) for migration window. + +```yaml +Type: System.DateTime +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationWindowStartTimeInUtc +Start time (UTC) for migration window. + +```yaml +Type: System.DateTime +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of migration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: MigrationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverwriteDbsInTarget +Indicates if databases on the target server can be overwritten when already present. +If set to 'False', when the migration workflow detects that the database already exists on the target server, it will wait for a confirmation. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +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: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretParameterSourceServerUsername +Gets or sets the name of the user for the source server. +This user doesn't need to be an administrator. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretParameterTargetServerUsername +Gets or sets the name of the user for the target server. +This user doesn't need to be an administrator. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SetupLogicalReplicationOnSourceDbIfNeeded +Indicates whether to setup logical replication on source server, if needed. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceDbServerFullyQualifiedDomainName +Fully qualified domain name (FQDN) or IP address of the source server. +This property is optional. +When provided, the migration service will always use it to connect to the source server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceDbServerResourceId +Identifier of the source database server resource, when 'sourceType' is 'PostgreSQLSingleServer'. +For other source types this must be set to ipaddress:port@username or hostname:port@username. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceType +Source server type used for the migration: ApsaraDB_RDS, AWS, AWS_AURORA, AWS_EC2, AWS_RDS, AzureVM, Crunchy_PostgreSQL, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, EDB, EDB_Oracle_Server, EDB_PostgreSQL, GCP, GCP_AlloyDB, GCP_CloudSQL, GCP_Compute, Heroku_PostgreSQL, Huawei_Compute, Huawei_RDS, OnPremises, PostgreSQLCosmosDB, PostgreSQLFlexibleServer, PostgreSQLSingleServer, or Supabase_PostgreSQL + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslMode +SSL mode used by a migration. +Default SSL mode for 'PostgreSQLSingleServer' is 'VerifyFull'. +Default SSL mode for other source types is 'Prefer'. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDataMigration +Indicates if data migration must start right away. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +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, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDbServerFullyQualifiedDomainName +Fully qualified domain name (FQDN) or IP address of the target server. +This property is optional. +When provided, the migration service will always use it to connect to the target server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggerCutover +Indicates if cutover must be triggered for the entire migration. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IMigration + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/New-AzPostgreSqlFlexibleServerThreatProtectionSetting.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/New-AzPostgreSqlFlexibleServerThreatProtectionSetting.md new file mode 100644 index 000000000000..c125591d1eeb --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/New-AzPostgreSqlFlexibleServerThreatProtectionSetting.md @@ -0,0 +1,246 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/new-azpostgresqlflexibleserverthreatprotectionsetting +schema: 2.0.0 +--- + +# New-AzPostgreSqlFlexibleServerThreatProtectionSetting + +## SYNOPSIS +Create a server's Advanced Threat Protection settings. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzPostgreSqlFlexibleServerThreatProtectionSetting -ResourceGroupName -ServerName + [-SubscriptionId ] [-State ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### CreateViaJsonFilePath +``` +New-AzPostgreSqlFlexibleServerThreatProtectionSetting -ResourceGroupName -ServerName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### CreateViaJsonString +``` +New-AzPostgreSqlFlexibleServerThreatProtectionSetting -ResourceGroupName -ServerName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Create a server's Advanced Threat Protection settings. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +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 +``` + +### -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 +``` + +### -ServerName +The name of 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 +``` + +### -State +Specifies the state of the advanced threat protection, whether it is enabled, disabled, or a state has not been applied yet on the server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```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 + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IAdvancedThreatProtectionSettingsModel + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/New-AzPostgreSqlFlexibleServerVirtualEndpoint.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/New-AzPostgreSqlFlexibleServerVirtualEndpoint.md new file mode 100644 index 000000000000..574520ddec8d --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/New-AzPostgreSqlFlexibleServerVirtualEndpoint.md @@ -0,0 +1,300 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/new-azpostgresqlflexibleservervirtualendpoint +schema: 2.0.0 +--- + +# New-AzPostgreSqlFlexibleServerVirtualEndpoint + +## SYNOPSIS +Create a pair of virtual endpoints for a server. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzPostgreSqlFlexibleServerVirtualEndpoint -Name -ResourceGroupName -ServerName + [-SubscriptionId ] [-EndpointType ] [-Member ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaIdentityFlexibleServerExpanded +``` +New-AzPostgreSqlFlexibleServerVirtualEndpoint -FlexibleServerInputObject + -Name [-EndpointType ] [-Member ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonFilePath +``` +New-AzPostgreSqlFlexibleServerVirtualEndpoint -Name -ResourceGroupName -ServerName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### CreateViaJsonString +``` +New-AzPostgreSqlFlexibleServerVirtualEndpoint -Name -ResourceGroupName -ServerName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Create a pair of virtual endpoints for a server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -EndpointType +Type of endpoint for the virtual endpoints. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Member +List of servers that one of the virtual endpoints can refer to. + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Base name of the virtual endpoints. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: VirtualEndpointName + +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 +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonFilePath, CreateViaJsonString +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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IVirtualEndpoint + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/README.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/README.md new file mode 100644 index 000000000000..7286363a786b --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/README.md @@ -0,0 +1,11 @@ +# Docs +This directory contains the documentation of the cmdlets for the `Az.PostgreSqlFlexibleServer` 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.PostgreSqlFlexibleServer` 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/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Remove-AzPostgreSqlFlexibleServer.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Remove-AzPostgreSqlFlexibleServer.md new file mode 100644 index 000000000000..6cb5d9f783e8 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Remove-AzPostgreSqlFlexibleServer.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/remove-azpostgresqlflexibleserver +schema: 2.0.0 +--- + +# Remove-AzPostgreSqlFlexibleServer + +## SYNOPSIS +Deletes or drops an existing server. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPostgreSqlFlexibleServer -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzPostgreSqlFlexibleServer -InputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes or drops an existing server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +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 server. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ServerName + +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. +The value must be an UUID. + +```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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Remove-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Remove-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md new file mode 100644 index 000000000000..38cec5fcb9b2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Remove-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md @@ -0,0 +1,262 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/remove-azpostgresqlflexibleserveradministratorsmicrosoftentra +schema: 2.0.0 +--- + +# Remove-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra + +## SYNOPSIS +Deletes an existing server administrator associated to a Microsoft Entra principal. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra -ObjectId -ResourceGroupName + -ServerName [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra -InputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentityFlexibleServer +``` +Remove-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra + -FlexibleServerInputObject -ObjectId + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes an existing server administrator associated to a Microsoft Entra principal. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: DeleteViaIdentityFlexibleServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 +``` + +### -ObjectId +Object identifier of the Microsoft Entra principal. + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityFlexibleServer +Aliases: + +Required: True +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 +``` + +### -ServerName +The name of the server. + +```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. +The value must be an UUID. + +```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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Remove-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Remove-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand.md new file mode 100644 index 000000000000..930979944003 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Remove-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand.md @@ -0,0 +1,262 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/remove-azpostgresqlflexibleserverbackupsautomaticandondemand +schema: 2.0.0 +--- + +# Remove-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand + +## SYNOPSIS +Deletes a specific backup, given its name. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand -BackupName -ResourceGroupName + -ServerName [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand -InputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentityFlexibleServer +``` +Remove-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand -BackupName + -FlexibleServerInputObject [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes a specific backup, given its name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -BackupName +Name of the backup. + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityFlexibleServer +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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: DeleteViaIdentityFlexibleServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 +``` + +### -ServerName +The name of the server. + +```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. +The value must be an UUID. + +```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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Remove-AzPostgreSqlFlexibleServerDatabase.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Remove-AzPostgreSqlFlexibleServerDatabase.md new file mode 100644 index 000000000000..debf6163cc4b --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Remove-AzPostgreSqlFlexibleServerDatabase.md @@ -0,0 +1,263 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/remove-azpostgresqlflexibleserverdatabase +schema: 2.0.0 +--- + +# Remove-AzPostgreSqlFlexibleServerDatabase + +## SYNOPSIS +Deletes an existing database. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPostgreSqlFlexibleServerDatabase -Name -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-AzPostgreSqlFlexibleServerDatabase -InputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentityFlexibleServer +``` +Remove-AzPostgreSqlFlexibleServerDatabase -FlexibleServerInputObject + -Name [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Deletes an existing database. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: DeleteViaIdentityFlexibleServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the database (case-sensitive). +Exact database names can be retrieved by getting the list of all existing databases in a server. + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityFlexibleServer +Aliases: DatabaseName + +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 +``` + +### -ServerName +The name of the server. + +```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. +The value must be an UUID. + +```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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Remove-AzPostgreSqlFlexibleServerFirewallRule.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Remove-AzPostgreSqlFlexibleServerFirewallRule.md new file mode 100644 index 000000000000..a060ddf39503 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Remove-AzPostgreSqlFlexibleServerFirewallRule.md @@ -0,0 +1,262 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/remove-azpostgresqlflexibleserverfirewallrule +schema: 2.0.0 +--- + +# Remove-AzPostgreSqlFlexibleServerFirewallRule + +## SYNOPSIS +Deletes an existing firewall rule. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPostgreSqlFlexibleServerFirewallRule -Name -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-AzPostgreSqlFlexibleServerFirewallRule -InputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentityFlexibleServer +``` +Remove-AzPostgreSqlFlexibleServerFirewallRule -FlexibleServerInputObject + -Name [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Deletes an existing firewall rule. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: DeleteViaIdentityFlexibleServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the firewall rule. + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityFlexibleServer +Aliases: FirewallRuleName + +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 +``` + +### -ServerName +The name of the server. + +```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. +The value must be an UUID. + +```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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Remove-AzPostgreSqlFlexibleServerVirtualEndpoint.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Remove-AzPostgreSqlFlexibleServerVirtualEndpoint.md new file mode 100644 index 000000000000..2211345621ee --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Remove-AzPostgreSqlFlexibleServerVirtualEndpoint.md @@ -0,0 +1,262 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/remove-azpostgresqlflexibleservervirtualendpoint +schema: 2.0.0 +--- + +# Remove-AzPostgreSqlFlexibleServerVirtualEndpoint + +## SYNOPSIS +Deletes a pair of virtual endpoints. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPostgreSqlFlexibleServerVirtualEndpoint -Name -ResourceGroupName + -ServerName [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzPostgreSqlFlexibleServerVirtualEndpoint -InputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentityFlexibleServer +``` +Remove-AzPostgreSqlFlexibleServerVirtualEndpoint + -FlexibleServerInputObject -Name [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes a pair of virtual endpoints. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: DeleteViaIdentityFlexibleServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Base name of the virtual endpoints. + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityFlexibleServer +Aliases: VirtualEndpointName + +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 +``` + +### -ServerName +The name of the server. + +```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. +The value must be an UUID. + +```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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Restart-AzPostgreSqlFlexibleServer.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Restart-AzPostgreSqlFlexibleServer.md new file mode 100644 index 000000000000..1691c462948f --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Restart-AzPostgreSqlFlexibleServer.md @@ -0,0 +1,332 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/restart-azpostgresqlflexibleserver +schema: 2.0.0 +--- + +# Restart-AzPostgreSqlFlexibleServer + +## SYNOPSIS +Restarts PostgreSQL database engine in a server. + +## SYNTAX + +### RestartExpanded (Default) +``` +Restart-AzPostgreSqlFlexibleServer -Name -ResourceGroupName [-SubscriptionId ] + [-FailoverMode ] [-RestartWithFailover] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### Restart +``` +Restart-AzPostgreSqlFlexibleServer -Name -ResourceGroupName -Parameter + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### RestartViaIdentity +``` +Restart-AzPostgreSqlFlexibleServer -InputObject + -Parameter [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] + [-WhatIf] [] +``` + +### RestartViaIdentityExpanded +``` +Restart-AzPostgreSqlFlexibleServer -InputObject [-FailoverMode ] + [-RestartWithFailover] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### RestartViaJsonFilePath +``` +Restart-AzPostgreSqlFlexibleServer -Name -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### RestartViaJsonString +``` +Restart-AzPostgreSqlFlexibleServer -Name -ResourceGroupName -JsonString + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Restarts PostgreSQL database engine in a server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -FailoverMode +Failover mode. + +```yaml +Type: System.String +Parameter Sets: RestartExpanded, RestartViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: RestartViaIdentity, RestartViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Restart operation + +```yaml +Type: System.String +Parameter Sets: RestartViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Restart operation + +```yaml +Type: System.String +Parameter Sets: RestartViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Restart, RestartExpanded, RestartViaJsonFilePath, RestartViaJsonString +Aliases: ServerName + +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 +``` + +### -Parameter +PostgreSQL database engine restart parameters. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IRestartParameter +Parameter Sets: Restart, RestartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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: Restart, RestartExpanded, RestartViaJsonFilePath, RestartViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestartWithFailover +Indicates if restart the PostgreSQL database engine should failover or switch over from primary to standby. +This only works if server has high availability enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RestartExpanded, RestartViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Restart, RestartExpanded, RestartViaJsonFilePath, RestartViaJsonString +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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IRestartParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Start-AzPostgreSqlFlexibleServer.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Start-AzPostgreSqlFlexibleServer.md new file mode 100644 index 000000000000..012847b8cbc8 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Start-AzPostgreSqlFlexibleServer.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/start-azpostgresqlflexibleserver +schema: 2.0.0 +--- + +# Start-AzPostgreSqlFlexibleServer + +## SYNOPSIS +Starts a stopped server. + +## SYNTAX + +### Start (Default) +``` +Start-AzPostgreSqlFlexibleServer -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### StartViaIdentity +``` +Start-AzPostgreSqlFlexibleServer -InputObject [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Starts a stopped server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: StartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: ServerName + +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: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention.md new file mode 100644 index 000000000000..768a52e8c77d --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention.md @@ -0,0 +1,316 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/start-azpostgresqlflexibleserverbackupslongtermretention +schema: 2.0.0 +--- + +# Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention + +## SYNOPSIS +Initiates a long term retention backup. + +## SYNTAX + +### StartViaIdentity (Default) +``` +Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention -InputObject + -Parameter [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### Start +``` +Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention -ResourceGroupName -ServerName + -Parameter [-SubscriptionId ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### StartExpanded +``` +Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention -ResourceGroupName -ServerName + -BackupSettingBackupName -TargetDetailSasUriList [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### StartViaIdentityExpanded +``` +Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention -InputObject + -BackupSettingBackupName -TargetDetailSasUriList [-DefaultProfile ] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### StartViaJsonFilePath +``` +Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention -ResourceGroupName -ServerName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### StartViaJsonString +``` +Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention -ResourceGroupName -ServerName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Initiates a long term retention backup. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -BackupSettingBackupName +Backup Name for the current backup + +```yaml +Type: System.String +Parameter Sets: StartExpanded, StartViaIdentityExpanded +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 +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: StartViaIdentity, StartViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Start operation + +```yaml +Type: System.String +Parameter Sets: StartViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Start operation + +```yaml +Type: System.String +Parameter Sets: StartViaJsonString +Aliases: + +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 +``` + +### -Parameter +The request that is made for a long term retention backup. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IBackupsLongTermRetentionRequest +Parameter Sets: Start, StartViaIdentity +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: Start, StartExpanded, StartViaJsonFilePath, StartViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Start, StartExpanded, StartViaJsonFilePath, StartViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Start, StartExpanded, StartViaJsonFilePath, StartViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDetailSasUriList +List of SAS uri of storage containers where backup data is to be streamed/copied. + +```yaml +Type: System.Security.SecureString[] +Parameter Sets: StartExpanded, StartViaIdentityExpanded +Aliases: + +Required: True +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.PostgreSqlFlexibleServer.Models.IBackupsLongTermRetentionRequest + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IBackupsLongTermRetentionResponse + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Stop-AzPostgreSqlFlexibleServer.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Stop-AzPostgreSqlFlexibleServer.md new file mode 100644 index 000000000000..e24095540555 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Stop-AzPostgreSqlFlexibleServer.md @@ -0,0 +1,224 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/stop-azpostgresqlflexibleserver +schema: 2.0.0 +--- + +# Stop-AzPostgreSqlFlexibleServer + +## SYNOPSIS +Stops a server. + +## SYNTAX + +### Stop (Default) +``` +Stop-AzPostgreSqlFlexibleServer -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### StopViaIdentity +``` +Stop-AzPostgreSqlFlexibleServer -InputObject [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Stops a server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: StopViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: ServerName + +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: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Stop-AzPostgreSqlFlexibleServerMigration.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Stop-AzPostgreSqlFlexibleServerMigration.md new file mode 100644 index 000000000000..6fb52ed3ec31 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Stop-AzPostgreSqlFlexibleServerMigration.md @@ -0,0 +1,230 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/stop-azpostgresqlflexibleservermigration +schema: 2.0.0 +--- + +# Stop-AzPostgreSqlFlexibleServerMigration + +## SYNOPSIS +Cancels an active migration. + +## SYNTAX + +### Cancel (Default) +``` +Stop-AzPostgreSqlFlexibleServerMigration -Name -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### CancelViaIdentity +``` +Stop-AzPostgreSqlFlexibleServerMigration -InputObject + [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### CancelViaIdentityFlexibleServer +``` +Stop-AzPostgreSqlFlexibleServerMigration -FlexibleServerInputObject + -Name [-DefaultProfile ] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Cancels an active migration. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: CancelViaIdentityFlexibleServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: CancelViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of migration. + +```yaml +Type: System.String +Parameter Sets: Cancel, CancelViaIdentityFlexibleServer +Aliases: MigrationName + +Required: True +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: Cancel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Cancel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Cancel +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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IMigration + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite.md new file mode 100644 index 000000000000..8f39b0ecfcce --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite.md @@ -0,0 +1,271 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/test-azpostgresqlflexibleserverbackupslongtermretentionprerequisite +schema: 2.0.0 +--- + +# Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite + +## SYNOPSIS +Performs all checks required for a long term retention backup operation to succeed. + +## SYNTAX + +### CheckExpanded (Default) +``` +Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite -ResourceGroupName + -ServerName -BackupSettingBackupName [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### Check +``` +Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite -ResourceGroupName + -ServerName -Parameter [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### CheckViaIdentity +``` +Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite + -InputObject -Parameter + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### CheckViaIdentityExpanded +``` +Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite + -InputObject -BackupSettingBackupName + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### CheckViaJsonFilePath +``` +Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite -ResourceGroupName + -ServerName -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +### CheckViaJsonString +``` +Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite -ResourceGroupName + -ServerName -JsonString [-SubscriptionId ] [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Performs all checks required for a long term retention backup operation to succeed. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -BackupSettingBackupName +Backup Name for the current backup + +```yaml +Type: System.String +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded +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 +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: CheckViaIdentity, CheckViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +A request that is made for pre-backup. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.ILtrPreBackupRequest +Parameter Sets: Check, CheckViaIdentity +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: Check, CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Check, CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Check, CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString +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.PostgreSqlFlexibleServer.Models.ILtrPreBackupRequest + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.ILtrPreBackupResponse + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Test-AzPostgreSqlFlexibleServerMigrationNameAvailability.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Test-AzPostgreSqlFlexibleServerMigrationNameAvailability.md new file mode 100644 index 000000000000..a1c7aa026fd6 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Test-AzPostgreSqlFlexibleServerMigrationNameAvailability.md @@ -0,0 +1,285 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/test-azpostgresqlflexibleservermigrationnameavailability +schema: 2.0.0 +--- + +# Test-AzPostgreSqlFlexibleServerMigrationNameAvailability + +## SYNOPSIS +Checks if a proposed migration name is valid and available. + +## SYNTAX + +### CheckExpanded (Default) +``` +Test-AzPostgreSqlFlexibleServerMigrationNameAvailability -ResourceGroupName -ServerName + -Name -Type [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### Check +``` +Test-AzPostgreSqlFlexibleServerMigrationNameAvailability -ResourceGroupName -ServerName + -Parameter [-SubscriptionId ] [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +### CheckViaIdentity +``` +Test-AzPostgreSqlFlexibleServerMigrationNameAvailability -InputObject + -Parameter [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### CheckViaIdentityExpanded +``` +Test-AzPostgreSqlFlexibleServerMigrationNameAvailability -InputObject + -Name -Type [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### CheckViaJsonFilePath +``` +Test-AzPostgreSqlFlexibleServerMigrationNameAvailability -ResourceGroupName -ServerName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### CheckViaJsonString +``` +Test-AzPostgreSqlFlexibleServerMigrationNameAvailability -ResourceGroupName -ServerName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Checks if a proposed migration name is valid and available. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: CheckViaIdentity, CheckViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the migration to check for validity and availability. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Availability of a migration name. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IMigrationNameAvailability +Parameter Sets: Check, CheckViaIdentity +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: Check, CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Check, CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Check, CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Type of resource. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded +Aliases: + +Required: True +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.PostgreSqlFlexibleServer.Models.IMigrationNameAvailability + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IMigrationNameAvailability + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Test-AzPostgreSqlFlexibleServerNameAvailability.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Test-AzPostgreSqlFlexibleServerNameAvailability.md new file mode 100644 index 000000000000..0cb71d1ce9d5 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Test-AzPostgreSqlFlexibleServerNameAvailability.md @@ -0,0 +1,266 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/test-azpostgresqlflexibleservernameavailability +schema: 2.0.0 +--- + +# Test-AzPostgreSqlFlexibleServerNameAvailability + +## SYNOPSIS +Check the availability of name for resource + +## SYNTAX + +### CheckExpanded (Default) +``` +Test-AzPostgreSqlFlexibleServerNameAvailability -LocationName [-SubscriptionId ] + [-Name ] [-Type ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### Check +``` +Test-AzPostgreSqlFlexibleServerNameAvailability -LocationName + -Parameter [-SubscriptionId ] [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +### CheckViaIdentity +``` +Test-AzPostgreSqlFlexibleServerNameAvailability -InputObject + -Parameter [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### CheckViaIdentityExpanded +``` +Test-AzPostgreSqlFlexibleServerNameAvailability -InputObject + [-Name ] [-Type ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### CheckViaJsonFilePath +``` +Test-AzPostgreSqlFlexibleServerNameAvailability -LocationName -JsonFilePath + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### CheckViaJsonString +``` +Test-AzPostgreSqlFlexibleServerNameAvailability -LocationName -JsonString + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Check the availability of name for resource + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: CheckViaIdentity, CheckViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationName +The name of the location. + +```yaml +Type: System.String +Parameter Sets: Check, CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the resource for which availability needs to be checked. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +The check availability request body. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.ICheckNameAvailabilityRequest +Parameter Sets: Check, CheckViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Check, CheckExpanded, CheckViaJsonFilePath, CheckViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The resource type. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded +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.PostgreSqlFlexibleServer.Models.ICheckNameAvailabilityRequest + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.INameAvailabilityModel + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Test-AzPostgreSqlFlexibleServerNameAvailabilityGlobally.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Test-AzPostgreSqlFlexibleServerNameAvailabilityGlobally.md new file mode 100644 index 000000000000..edb63be44acb --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Test-AzPostgreSqlFlexibleServerNameAvailabilityGlobally.md @@ -0,0 +1,220 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/test-azpostgresqlflexibleservernameavailabilityglobally +schema: 2.0.0 +--- + +# Test-AzPostgreSqlFlexibleServerNameAvailabilityGlobally + +## SYNOPSIS +Checks the validity and availability of the given name, to assign it to a new server or to use it as the base name of a new pair of virtual endpoints. + +## SYNTAX + +### CheckExpanded (Default) +``` +Test-AzPostgreSqlFlexibleServerNameAvailabilityGlobally [-SubscriptionId ] [-Name ] + [-Type ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### Check +``` +Test-AzPostgreSqlFlexibleServerNameAvailabilityGlobally -Parameter + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### CheckViaJsonFilePath +``` +Test-AzPostgreSqlFlexibleServerNameAvailabilityGlobally -JsonFilePath [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### CheckViaJsonString +``` +Test-AzPostgreSqlFlexibleServerNameAvailabilityGlobally -JsonString [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Checks the validity and availability of the given name, to assign it to a new server or to use it as the base name of a new pair of virtual endpoints. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -JsonFilePath +Path of Json file supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the resource for which availability needs to be checked. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +The check availability request body. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.ICheckNameAvailabilityRequest +Parameter Sets: Check +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```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 +``` + +### -Type +The resource type. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +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.PostgreSqlFlexibleServer.Models.ICheckNameAvailabilityRequest + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.INameAvailabilityModel + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Update-AzPostgreSqlFlexibleServer.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Update-AzPostgreSqlFlexibleServer.md new file mode 100644 index 000000000000..d56673cc651f --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Update-AzPostgreSqlFlexibleServer.md @@ -0,0 +1,837 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/update-azpostgresqlflexibleserver +schema: 2.0.0 +--- + +# Update-AzPostgreSqlFlexibleServer + +## SYNOPSIS +Update a new server. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPostgreSqlFlexibleServer -Name -ResourceGroupName [-SubscriptionId ] + [-AdministratorLoginPassword ] [-AuthConfigActiveDirectoryAuth ] + [-AuthConfigPasswordAuth ] [-AuthConfigTenantId ] [-BackupRetentionDay ] + [-ClusterDefaultDatabaseName ] [-ClusterSize ] [-CreateMode ] + [-DataEncryptionGeoBackupKeyUri ] [-DataEncryptionGeoBackupUserAssignedIdentityId ] + [-DataEncryptionPrimaryKeyUri ] [-DataEncryptionPrimaryUserAssignedIdentityId ] + [-DataEncryptionType ] [-EnableSystemAssignedIdentity ] [-HighAvailabilityMode ] + [-HighAvailabilityStandbyAvailabilityZone ] [-IdentityPrincipalId ] + [-MaintenanceWindowCustomWindow ] [-MaintenanceWindowDayOfWeek ] + [-MaintenanceWindowStartHour ] [-MaintenanceWindowStartMinute ] + [-NetworkDelegatedSubnetResourceId ] [-NetworkPrivateDnsZoneArmResourceId ] + [-NetworkPublicNetworkAccess ] [-ReplicaPromoteMode ] [-ReplicaPromoteOption ] + [-ReplicaRole ] [-ReplicationRole ] [-SkuName ] [-SkuTier ] + [-StorageAutoGrow ] [-StorageIop ] [-StorageSizeGb ] [-StorageThroughput ] + [-StorageTier ] [-StorageType ] [-Tag ] [-UserAssignedIdentity ] + [-Version ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPostgreSqlFlexibleServer -InputObject + [-AdministratorLoginPassword ] [-AuthConfigActiveDirectoryAuth ] + [-AuthConfigPasswordAuth ] [-AuthConfigTenantId ] [-BackupRetentionDay ] + [-ClusterDefaultDatabaseName ] [-ClusterSize ] [-CreateMode ] + [-DataEncryptionGeoBackupKeyUri ] [-DataEncryptionGeoBackupUserAssignedIdentityId ] + [-DataEncryptionPrimaryKeyUri ] [-DataEncryptionPrimaryUserAssignedIdentityId ] + [-DataEncryptionType ] [-EnableSystemAssignedIdentity ] [-HighAvailabilityMode ] + [-HighAvailabilityStandbyAvailabilityZone ] [-IdentityPrincipalId ] + [-MaintenanceWindowCustomWindow ] [-MaintenanceWindowDayOfWeek ] + [-MaintenanceWindowStartHour ] [-MaintenanceWindowStartMinute ] + [-NetworkDelegatedSubnetResourceId ] [-NetworkPrivateDnsZoneArmResourceId ] + [-NetworkPublicNetworkAccess ] [-ReplicaPromoteMode ] [-ReplicaPromoteOption ] + [-ReplicaRole ] [-ReplicationRole ] [-SkuName ] [-SkuTier ] + [-StorageAutoGrow ] [-StorageIop ] [-StorageSizeGb ] [-StorageThroughput ] + [-StorageTier ] [-StorageType ] [-Tag ] [-UserAssignedIdentity ] + [-Version ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Update a new server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AdministratorLoginPassword +Password assigned to the administrator login. +As long as password authentication is enabled, this password can be changed at any time. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -AuthConfigActiveDirectoryAuth +Indicates if the server supports Microsoft Entra authentication. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthConfigPasswordAuth +Indicates if the server supports password based authentication. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthConfigTenantId +Identifier of the tenant of the delegated resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupRetentionDay +Backup retention days for the server. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterDefaultDatabaseName +Default database name for the elastic cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterSize +Number of nodes assigned to the elastic cluster. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreateMode +Creation mode of a new server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataEncryptionGeoBackupKeyUri +Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a server that is configured to support geographically redundant backups. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataEncryptionGeoBackupUserAssignedIdentityId +Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a server that is configured to support geographically redundant backups. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataEncryptionPrimaryKeyUri +URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataEncryptionPrimaryUserAssignedIdentityId +Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the primary storage associated to a server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataEncryptionType +Data encryption type used by a server. + +```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 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 +``` + +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. + +```yaml +Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighAvailabilityMode +High availability mode for a server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighAvailabilityStandbyAvailabilityZone +Availability zone associated to the standby server created when high availability is set to SameZone or ZoneRedundant. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityPrincipalId +Identifier of the object of the service principal associated to the user assigned managed identity. + +```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 + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MaintenanceWindowCustomWindow +Indicates whether custom window is enabled or disabled. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaintenanceWindowDayOfWeek +Day of the week to be used for maintenance window. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaintenanceWindowStartHour +Start hour to be used for maintenance window. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaintenanceWindowStartMinute +Start minute to be used for maintenance window. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkDelegatedSubnetResourceId +Resource identifier of the delegated subnet. +Required during creation of a new server, in case you want the server to be integrated into your own virtual network. +For an update operation, you only have to provide this property if you want to change the value assigned for the private DNS zone. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkPrivateDnsZoneArmResourceId +Identifier of the private DNS zone. +Required during creation of a new server, in case you want the server to be integrated into your own virtual network. +For an update operation, you only have to provide this property if you want to change the value assigned for the private DNS zone. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkPublicNetworkAccess +Indicates if public network access is enabled or not. +This is only supported for servers that are not integrated into a virtual network which is owned and provided by customer when server is deployed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +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 +``` + +### -ReplicaPromoteMode +Type of operation to apply on the read replica. +This property is write only. +Standalone means that the read replica will be promoted to a standalone server, and will become a completely independent entity from the replication set. +Switchover means that the read replica will roles with the primary server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicaPromoteOption +Data synchronization option to use when processing the operation specified in the promoteMode property. +This property is write only. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicaRole +Role of the server in a replication set. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationRole +Role of the server in a replication set. + +```yaml +Type: System.String +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: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +Name by which is known a given compute size assigned to a server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +Tier of the compute assigned to a server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAutoGrow +Flag to enable or disable the automatic growth of storage size of a server when available space is nearing zero and conditions allow for automatically growing storage size. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageIop +Maximum IOPS supported for storage. +Required when type of storage is PremiumV2_LRS or UltraSSD_LRS. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageSizeGb +Size of storage assigned to a server. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageThroughput +Maximum throughput supported for storage. +Required when type of storage is PremiumV2_LRS or UltraSSD_LRS. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageTier +Storage tier of a server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageType +Type of storage assigned to a server. +Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. +If not specified, it defaults to Premium_LRS. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```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 +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The array of user assigned identities associated with the resource. +The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.' + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Major version of PostgreSQL database engine. + +```yaml +Type: System.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: 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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IServer + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Update-AzPostgreSqlFlexibleServerConfiguration.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Update-AzPostgreSqlFlexibleServerConfiguration.md new file mode 100644 index 000000000000..558911c7317b --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Update-AzPostgreSqlFlexibleServerConfiguration.md @@ -0,0 +1,324 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/update-azpostgresqlflexibleserverconfiguration +schema: 2.0.0 +--- + +# Update-AzPostgreSqlFlexibleServerConfiguration + +## SYNOPSIS +Update the value assigned to a specific modifiable configuration (also known as server parameter) of a server. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPostgreSqlFlexibleServerConfiguration -Name -ResourceGroupName -ServerName + [-SubscriptionId ] [-Source ] [-Value ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPostgreSqlFlexibleServerConfiguration -InputObject + [-Source ] [-Value ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaIdentityFlexibleServerExpanded +``` +Update-AzPostgreSqlFlexibleServerConfiguration -FlexibleServerInputObject + -Name [-Source ] [-Value ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzPostgreSqlFlexibleServerConfiguration -Name -ResourceGroupName -ServerName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaJsonString +``` +Update-AzPostgreSqlFlexibleServerConfiguration -Name -ResourceGroupName -ServerName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Update the value assigned to a specific modifiable configuration (also known as server parameter) of a server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: UpdateViaIdentityFlexibleServerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the configuration (also known as server parameter). + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityFlexibleServerExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: ConfigurationName + +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 +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Source +Source of the value assigned to the configuration (also known as server parameter). +Required to update the value assigned to a specific modifiable configuration. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +Value of the configuration (also known as server parameter). +Required to update the value assigned to a specific modifiable configuration. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityFlexibleServerExpanded +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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IConfiguration + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Update-AzPostgreSqlFlexibleServerDatabase.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Update-AzPostgreSqlFlexibleServerDatabase.md new file mode 100644 index 000000000000..48bf44e028d0 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Update-AzPostgreSqlFlexibleServerDatabase.md @@ -0,0 +1,279 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/update-azpostgresqlflexibleserverdatabase +schema: 2.0.0 +--- + +# Update-AzPostgreSqlFlexibleServerDatabase + +## SYNOPSIS +Update a new database. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPostgreSqlFlexibleServerDatabase -Name -ResourceGroupName -ServerName + [-SubscriptionId ] [-Charset ] [-Collation ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPostgreSqlFlexibleServerDatabase -InputObject [-Charset ] + [-Collation ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaIdentityFlexibleServerExpanded +``` +Update-AzPostgreSqlFlexibleServerDatabase -FlexibleServerInputObject + -Name [-Charset ] [-Collation ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Update a new database. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -Charset +Character set of the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Collation +Collation of the database. + +```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 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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: UpdateViaIdentityFlexibleServerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the database (case-sensitive). +Exact database names can be retrieved by getting the list of all existing databases in a server. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityFlexibleServerExpanded +Aliases: DatabaseName + +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 +``` + +### -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 +``` + +### -ServerName +The name of the server. + +```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. +The value must be an UUID. + +```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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IDatabase + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Update-AzPostgreSqlFlexibleServerFirewallRule.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Update-AzPostgreSqlFlexibleServerFirewallRule.md new file mode 100644 index 000000000000..b490f990ad6d --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Update-AzPostgreSqlFlexibleServerFirewallRule.md @@ -0,0 +1,280 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/update-azpostgresqlflexibleserverfirewallrule +schema: 2.0.0 +--- + +# Update-AzPostgreSqlFlexibleServerFirewallRule + +## SYNOPSIS +Update a new firewall rule or update an existing firewall rule. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPostgreSqlFlexibleServerFirewallRule -Name -ResourceGroupName -ServerName + [-SubscriptionId ] [-EndIPAddress ] [-StartIPAddress ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPostgreSqlFlexibleServerFirewallRule -InputObject + [-EndIPAddress ] [-StartIPAddress ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityFlexibleServerExpanded +``` +Update-AzPostgreSqlFlexibleServerFirewallRule -FlexibleServerInputObject + -Name [-EndIPAddress ] [-StartIPAddress ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Update a new firewall rule or update an existing firewall rule. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -EndIPAddress +IP address defining the end of the range of addresses of a firewall rule. +Must be expressed in IPv4 format. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: UpdateViaIdentityFlexibleServerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the firewall rule. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityFlexibleServerExpanded +Aliases: FirewallRuleName + +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 +``` + +### -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 +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartIPAddress +IP address defining the start of the range of addresses of a firewall rule. +Must be expressed in IPv4 format. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IFirewallRule + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Update-AzPostgreSqlFlexibleServerMigration.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Update-AzPostgreSqlFlexibleServerMigration.md new file mode 100644 index 000000000000..f2726ab0b608 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Update-AzPostgreSqlFlexibleServerMigration.md @@ -0,0 +1,580 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/update-azpostgresqlflexibleservermigration +schema: 2.0.0 +--- + +# Update-AzPostgreSqlFlexibleServerMigration + +## SYNOPSIS +Update an existing migration. +The request body can contain one to many of the mutable properties present in the migration definition. +Certain property update initiate migration state transitions. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPostgreSqlFlexibleServerMigration -Name -ResourceGroupName -ServerName + [-SubscriptionId ] [-AdminCredentialsSourceServerPassword ] + [-AdminCredentialsTargetServerPassword ] [-Cancel ] + [-DbsToCancelMigrationOn ] [-DbsToMigrate ] [-DbsToTriggerCutoverOn ] + [-MigrateRole ] [-MigrationMode ] [-MigrationWindowStartTimeInUtc ] + [-OverwriteDbsInTarget ] [-SecretParameterSourceServerUsername ] + [-SecretParameterTargetServerUsername ] [-SetupLogicalReplicationOnSourceDbIfNeeded ] + [-SourceDbServerFullyQualifiedDomainName ] [-SourceDbServerResourceId ] + [-StartDataMigration ] [-Tag ] [-TargetDbServerFullyQualifiedDomainName ] + [-TriggerCutover ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPostgreSqlFlexibleServerMigration -InputObject + [-AdminCredentialsSourceServerPassword ] [-AdminCredentialsTargetServerPassword ] + [-Cancel ] [-DbsToCancelMigrationOn ] [-DbsToMigrate ] + [-DbsToTriggerCutoverOn ] [-MigrateRole ] [-MigrationMode ] + [-MigrationWindowStartTimeInUtc ] [-OverwriteDbsInTarget ] + [-SecretParameterSourceServerUsername ] [-SecretParameterTargetServerUsername ] + [-SetupLogicalReplicationOnSourceDbIfNeeded ] [-SourceDbServerFullyQualifiedDomainName ] + [-SourceDbServerResourceId ] [-StartDataMigration ] [-Tag ] + [-TargetDbServerFullyQualifiedDomainName ] [-TriggerCutover ] [-DefaultProfile ] + [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityFlexibleServerExpanded +``` +Update-AzPostgreSqlFlexibleServerMigration -FlexibleServerInputObject + -Name [-AdminCredentialsSourceServerPassword ] + [-AdminCredentialsTargetServerPassword ] [-Cancel ] + [-DbsToCancelMigrationOn ] [-DbsToMigrate ] [-DbsToTriggerCutoverOn ] + [-MigrateRole ] [-MigrationMode ] [-MigrationWindowStartTimeInUtc ] + [-OverwriteDbsInTarget ] [-SecretParameterSourceServerUsername ] + [-SecretParameterTargetServerUsername ] [-SetupLogicalReplicationOnSourceDbIfNeeded ] + [-SourceDbServerFullyQualifiedDomainName ] [-SourceDbServerResourceId ] + [-StartDataMigration ] [-Tag ] [-TargetDbServerFullyQualifiedDomainName ] + [-TriggerCutover ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzPostgreSqlFlexibleServerMigration -Name -ResourceGroupName -ServerName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaJsonString +``` +Update-AzPostgreSqlFlexibleServerMigration -Name -ResourceGroupName -ServerName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Update an existing migration. +The request body can contain one to many of the mutable properties present in the migration definition. +Certain property update initiate migration state transitions. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AdminCredentialsSourceServerPassword +Password for the user of the source server. + +```yaml +Type: System.Security.SecureString +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminCredentialsTargetServerPassword +Password for the user of the target server. + +```yaml +Type: System.Security.SecureString +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Cancel +Indicates if cancel must be triggered for the entire migration. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DbsToCancelMigrationOn +When you want to trigger cancel for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array. + +```yaml +Type: System.String[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DbsToMigrate +Names of databases to migrate. + +```yaml +Type: System.String[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DbsToTriggerCutoverOn +When you want to trigger cutover for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array. + +```yaml +Type: System.String[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityFlexibleServerExpanded +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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: UpdateViaIdentityFlexibleServerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrateRole +Indicates if roles and permissions must be migrated. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationMode +Mode used to perform the migration: Online or Offline. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationWindowStartTimeInUtc +Start time (UTC) for migration window. + +```yaml +Type: System.DateTime +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of migration. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityFlexibleServerExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: MigrationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverwriteDbsInTarget +Indicates if databases on the target server can be overwritten when already present. +If set to 'False', when the migration workflow detects that the database already exists on the target server, it will wait for a confirmation. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityFlexibleServerExpanded +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: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretParameterSourceServerUsername +Gets or sets the name of the user for the source server. +This user doesn't need to be an administrator. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretParameterTargetServerUsername +Gets or sets the name of the user for the target server. +This user doesn't need to be an administrator. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SetupLogicalReplicationOnSourceDbIfNeeded +Indicates whether to setup logical replication on source server, if needed. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceDbServerFullyQualifiedDomainName +Fully qualified domain name (FQDN) or IP address of the source server. +This property is optional. +When provided, the migration service will always use it to connect to the source server. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceDbServerResourceId +Identifier of the source database server resource, when 'sourceType' is 'PostgreSQLSingleServer'. +For other source types this must be set to ipaddress:port@username or hostname:port@username. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDataMigration +Indicates if data migration must start right away. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Application-specific metadata in the form of key-value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDbServerFullyQualifiedDomainName +Fully qualified domain name (FQDN) or IP address of the target server. +This property is optional. +When provided, the migration service will always use it to connect to the target server. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggerCutover +Indicates if cutover must be triggered for the entire migration. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityFlexibleServerExpanded +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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IMigration + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Update-AzPostgreSqlFlexibleServerVirtualEndpoint.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Update-AzPostgreSqlFlexibleServerVirtualEndpoint.md new file mode 100644 index 000000000000..1b3bb7ef1b85 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/docs/Update-AzPostgreSqlFlexibleServerVirtualEndpoint.md @@ -0,0 +1,323 @@ +--- +external help file: +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/update-azpostgresqlflexibleservervirtualendpoint +schema: 2.0.0 +--- + +# Update-AzPostgreSqlFlexibleServerVirtualEndpoint + +## SYNOPSIS +Update a pair of virtual endpoints for a server. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPostgreSqlFlexibleServerVirtualEndpoint -Name -ResourceGroupName + -ServerName [-SubscriptionId ] [-EndpointType ] [-Member ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPostgreSqlFlexibleServerVirtualEndpoint -InputObject + [-EndpointType ] [-Member ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaIdentityFlexibleServerExpanded +``` +Update-AzPostgreSqlFlexibleServerVirtualEndpoint + -FlexibleServerInputObject -Name [-EndpointType ] + [-Member ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzPostgreSqlFlexibleServerVirtualEndpoint -Name -ResourceGroupName + -ServerName -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaJsonString +``` +Update-AzPostgreSqlFlexibleServerVirtualEndpoint -Name -ResourceGroupName + -ServerName -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Update a pair of virtual endpoints for a server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -EndpointType +Type of endpoint for the virtual endpoints. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: UpdateViaIdentityFlexibleServerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Member +List of servers that one of the virtual endpoints can refer to. + +```yaml +Type: System.String[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Base name of the virtual endpoints. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityFlexibleServerExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: VirtualEndpointName + +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 +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IVirtualEndpoint + +## NOTES + +## RELATED LINKS + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServer.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServer.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServer.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerAdvancedThreatProtectionSetting.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerAdvancedThreatProtectionSetting.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerAdvancedThreatProtectionSetting.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerBackupsLongTermRetention.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerBackupsLongTermRetention.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerBackupsLongTermRetention.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerCapabilitiesByLocation.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerCapabilitiesByLocation.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerCapabilitiesByLocation.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerCapabilitiesByServer.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerCapabilitiesByServer.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerCapabilitiesByServer.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerCapturedLog.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerCapturedLog.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerCapturedLog.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerConfiguration.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerConfiguration.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerConfiguration.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerDatabase.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerDatabase.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerDatabase.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerFirewallRule.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerFirewallRule.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerFirewallRule.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerMigration.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerMigration.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerMigration.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerPrivateDnsZoneSuffix.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerPrivateDnsZoneSuffix.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerPrivateDnsZoneSuffix.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerQuotaUsage.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerQuotaUsage.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerQuotaUsage.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerReplica.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerReplica.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerReplica.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerTuningOption.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerTuningOption.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerTuningOption.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerTuningOptionRecommendation.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerTuningOptionRecommendation.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerTuningOptionRecommendation.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerVirtualEndpoint.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerVirtualEndpoint.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerVirtualEndpoint.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerVirtualNetworkSubnetUsage.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerVirtualNetworkSubnetUsage.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Get-AzPostgreSqlFlexibleServerVirtualNetworkSubnetUsage.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/New-AzPostgreSqlFlexibleServer.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/New-AzPostgreSqlFlexibleServer.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/New-AzPostgreSqlFlexibleServer.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/New-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/New-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/New-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/New-AzPostgreSqlFlexibleServerDatabase.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/New-AzPostgreSqlFlexibleServerDatabase.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/New-AzPostgreSqlFlexibleServerDatabase.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/New-AzPostgreSqlFlexibleServerFirewallRule.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/New-AzPostgreSqlFlexibleServerFirewallRule.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/New-AzPostgreSqlFlexibleServerFirewallRule.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/New-AzPostgreSqlFlexibleServerMigration.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/New-AzPostgreSqlFlexibleServerMigration.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/New-AzPostgreSqlFlexibleServerMigration.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/New-AzPostgreSqlFlexibleServerThreatProtectionSetting.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/New-AzPostgreSqlFlexibleServerThreatProtectionSetting.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/New-AzPostgreSqlFlexibleServerThreatProtectionSetting.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/New-AzPostgreSqlFlexibleServerVirtualEndpoint.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/New-AzPostgreSqlFlexibleServerVirtualEndpoint.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/New-AzPostgreSqlFlexibleServerVirtualEndpoint.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Remove-AzPostgreSqlFlexibleServer.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Remove-AzPostgreSqlFlexibleServer.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Remove-AzPostgreSqlFlexibleServer.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Remove-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Remove-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Remove-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Remove-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Remove-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Remove-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Remove-AzPostgreSqlFlexibleServerDatabase.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Remove-AzPostgreSqlFlexibleServerDatabase.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Remove-AzPostgreSqlFlexibleServerDatabase.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Remove-AzPostgreSqlFlexibleServerFirewallRule.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Remove-AzPostgreSqlFlexibleServerFirewallRule.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Remove-AzPostgreSqlFlexibleServerFirewallRule.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Remove-AzPostgreSqlFlexibleServerVirtualEndpoint.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Remove-AzPostgreSqlFlexibleServerVirtualEndpoint.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Remove-AzPostgreSqlFlexibleServerVirtualEndpoint.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Restart-AzPostgreSqlFlexibleServer.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Restart-AzPostgreSqlFlexibleServer.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Restart-AzPostgreSqlFlexibleServer.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Start-AzPostgreSqlFlexibleServer.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Start-AzPostgreSqlFlexibleServer.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Start-AzPostgreSqlFlexibleServer.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Stop-AzPostgreSqlFlexibleServer.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Stop-AzPostgreSqlFlexibleServer.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Stop-AzPostgreSqlFlexibleServer.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Stop-AzPostgreSqlFlexibleServerMigration.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Stop-AzPostgreSqlFlexibleServerMigration.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Stop-AzPostgreSqlFlexibleServerMigration.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Test-AzPostgreSqlFlexibleServerMigrationNameAvailability.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Test-AzPostgreSqlFlexibleServerMigrationNameAvailability.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Test-AzPostgreSqlFlexibleServerMigrationNameAvailability.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Test-AzPostgreSqlFlexibleServerNameAvailability.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Test-AzPostgreSqlFlexibleServerNameAvailability.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Test-AzPostgreSqlFlexibleServerNameAvailability.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Test-AzPostgreSqlFlexibleServerNameAvailabilityGlobally.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Test-AzPostgreSqlFlexibleServerNameAvailabilityGlobally.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Test-AzPostgreSqlFlexibleServerNameAvailabilityGlobally.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Update-AzPostgreSqlFlexibleServer.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Update-AzPostgreSqlFlexibleServer.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Update-AzPostgreSqlFlexibleServer.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Update-AzPostgreSqlFlexibleServerConfiguration.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Update-AzPostgreSqlFlexibleServerConfiguration.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Update-AzPostgreSqlFlexibleServerConfiguration.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Update-AzPostgreSqlFlexibleServerDatabase.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Update-AzPostgreSqlFlexibleServerDatabase.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Update-AzPostgreSqlFlexibleServerDatabase.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Update-AzPostgreSqlFlexibleServerFirewallRule.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Update-AzPostgreSqlFlexibleServerFirewallRule.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Update-AzPostgreSqlFlexibleServerFirewallRule.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Update-AzPostgreSqlFlexibleServerMigration.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Update-AzPostgreSqlFlexibleServerMigration.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Update-AzPostgreSqlFlexibleServerMigration.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Update-AzPostgreSqlFlexibleServerVirtualEndpoint.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Update-AzPostgreSqlFlexibleServerVirtualEndpoint.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/examples/Update-AzPostgreSqlFlexibleServerVirtualEndpoint.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/generate-info.json b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/generate-info.json new file mode 100644 index 000000000000..df1bb5662ba5 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/generate-info.json @@ -0,0 +1,3 @@ +{ + "generate_Id": "9dfbd720-7cb9-430f-9984-8e15ac66c0b3" +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/how-to.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/how-to.md new file mode 100644 index 000000000000..93ca68181859 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/how-to.md @@ -0,0 +1,58 @@ +# How-To +This document describes how to develop for `Az.PostgreSqlFlexibleServer`. + +## Building `Az.PostgreSqlFlexibleServer` +To build, run the `build-module.ps1` at the root of the module directory. This will generate the proxy script cmdlets that are the cmdlets being exported by this module. After the build completes, the proxy script cmdlets will be output to the `exports` folder. To read more about the proxy script cmdlets, look at the [README.md](exports/README.md) in the `exports` folder. + +## Creating custom cmdlets +To add cmdlets that were not generated by the REST specification, use the `custom` folder. This folder allows you to add handwritten `.ps1` and `.cs` files. Currently, we support using `.ps1` scripts as new cmdlets or as additional low-level variants (via `ParameterSet`), and `.cs` files as low-level (variants) cmdlets that the exported script cmdlets call. We do not support exporting any `.cs` (dll) cmdlets directly. To read more about custom cmdlets, look at the [README.md](custom/README.md) in the `custom` folder. + +## Generating documentation +To generate documentation, the process is now integrated into the `build-module.ps1` script. If you don't want to run this process as part of `build-module.ps1`, you can provide the `-NoDocs` switch. If you want to run documentation generation after the build process, you may still run the `generate-help.ps1` script. Overall, the process will look at the documentation comments in the generated and custom cmdlets and types, and create `.md` files into the `docs` folder. Additionally, this pulls in any examples from the `examples` folder and adds them to the generated help markdown documents. To read more about examples, look at the [README.md](examples/README.md) in the `examples` folder. To read more about documentation, look at the [README.md](docs/README.md) in the `docs` folder. + +## Testing `Az.PostgreSqlFlexibleServer` +To test the cmdlets, we use [Pester](https://github.com/pester/Pester). Tests scripts (`.ps1`) should be added to the `test` folder. To execute the Pester tests, run the `test-module.ps1` script. This will run all tests in `playback` mode within the `test` folder. To read more about testing cmdlets, look at the [README.md](examples/README.md) in the `examples` folder. + +## Packing `Az.PostgreSqlFlexibleServer` +To pack `Az.PostgreSqlFlexibleServer` for distribution, run the `pack-module.ps1` script. This will take the contents of multiple directories and certain root-folder files to create a `.nupkg`. The structure of the `.nupkg` is created so it can be loaded part of a [PSRepository](https://learn.microsoft.com/powershell/module/powershellget/register-psrepository). Additionally, this package is in a format for distribution to the [PSGallery](https://www.powershellgallery.com/). For signing an Azure module, please contact the [Azure PowerShell](https://github.com/Azure/azure-powershell) team. + +## Module Script Details +There are multiple scripts created for performing different actions for developing `Az.PostgreSqlFlexibleServer`. +- `build-module.ps1` + - Builds the module DLL (`./bin/Az.PostgreSqlFlexibleServer.private.dll`), creates the exported cmdlets and documentation, generates custom cmdlet test stubs and exported cmdlet example stubs, and updates `./Az.PostgreSqlFlexibleServer.psd1` with Azure profile information. + - **Parameters**: [`Switch` parameters] + - `-Run`: After building, creates an isolated PowerShell session and loads `Az.PostgreSqlFlexibleServer`. + - `-Test`: After building, runs the `Pester` tests defined in the `test` folder. + - `-Docs`: After building, generates the Markdown documents for the modules into the `docs` folder. + - `-Pack`: After building, packages the module into a `.nupkg`. + - `-Code`: After building, opens a VSCode window with the module's directory and runs (see `-Run`) the module. + - `-Release`: Builds the module in `Release` configuration (as opposed to `Debug` configuration). + - `-NoDocs`: Supresses writing the documentation markdown files as part of the cmdlet exporting process. + - `-Debugger`: Used when attaching the debugger in Visual Studio to the PowerShell session, and running the build process without recompiling the DLL. This suppresses running the script as an isolated process. +- `run-module.ps1` + - Creates an isolated PowerShell session and loads `Az.PostgreSqlFlexibleServer` into the session. + - Same as `-Run` in `build-module.ps1`. + - **Parameters**: [`Switch` parameters] + - `-Code`: Opens a VSCode window with the module's directory. + - Same as `-Code` in `build-module.ps1`. +- `generate-help.ps1` + - Generates the Markdown documents for the modules into the `docs` folder. + - Same as `-Docs` in `build-module.ps1`. +- `test-module.ps1` + - Runs the `Pester` tests defined in the `test` folder. + - Same as `-Test` in `build-module.ps1`. +- `pack-module.ps1` + - Packages the module into a `.nupkg` for distribution. + - Same as `-Pack` in `build-module.ps1`. +- `generate-help.ps1` + - Generates the Markdown documents for the modules into the `docs` folder. + - Same as `-Docs` in `build-module.ps1`. + - This process is now integrated into `build-module.ps1` automatically. To disable, use `-NoDocs` when running `build-module.ps1`. +- `export-surface.ps1` + - Generates Markdown documents for both the cmdlet surface and the model (class) surface of the module. + - These files are placed into the `resources` folder. + - Used for investigating the surface of your module. These are *not* documentation for distribution. +- `check-dependencies.ps1` + - Used in `run-module.ps1` and `test-module.ps1` to verify dependent modules are available to run those tasks. + - It will download local (within the module's directory structure) versions of those modules as needed. + - This script *does not* need to be ran by-hand. \ No newline at end of file diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/resources/README.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/resources/README.md new file mode 100644 index 000000000000..937f07f8fec2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/resources/README.md @@ -0,0 +1,11 @@ +# Resources +This directory can contain any additional resources for module that are not required at runtime. This directory **does not** get packaged with the module. If you have assets for custom implementation, place them into the `..\custom` folder. + +## Info +- Modifiable: yes +- Generated: no +- Committed: yes +- Packaged: no + +## Purpose +Use this folder to put anything you want to keep around as part of the repository for the module, but is not something that is required for the module. For example, development files, packaged builds, or additional information. This is only intended to be used in repositories where the module's output directory is cleaned, but tangential resources for the module want to remain intact. \ No newline at end of file diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServer.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServer.Tests.ps1 new file mode 100644 index 000000000000..31bf3147c401 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServer.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzPostgreSqlFlexibleServer')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzPostgreSqlFlexibleServer.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 'Get-AzPostgreSqlFlexibleServer' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'List1' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.Tests.ps1 new file mode 100644 index 000000000000..1b61824bb1cc --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.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 'Get-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentityFlexibleServer' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerAdvancedThreatProtectionSetting.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerAdvancedThreatProtectionSetting.Tests.ps1 new file mode 100644 index 000000000000..1bc66bbc1bb1 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerAdvancedThreatProtectionSetting.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzPostgreSqlFlexibleServerAdvancedThreatProtectionSetting')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzPostgreSqlFlexibleServerAdvancedThreatProtectionSetting.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 'Get-AzPostgreSqlFlexibleServerAdvancedThreatProtectionSetting' { + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand.Tests.ps1 new file mode 100644 index 000000000000..4ba8582109cd --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand.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 'Get-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentityFlexibleServer' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerBackupsLongTermRetention.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerBackupsLongTermRetention.Tests.ps1 new file mode 100644 index 000000000000..0873d14730fb --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerBackupsLongTermRetention.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzPostgreSqlFlexibleServerBackupsLongTermRetention')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzPostgreSqlFlexibleServerBackupsLongTermRetention.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 'Get-AzPostgreSqlFlexibleServerBackupsLongTermRetention' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentityFlexibleServer' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerCapabilitiesByLocation.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerCapabilitiesByLocation.Tests.ps1 new file mode 100644 index 000000000000..3464393bcb82 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerCapabilitiesByLocation.Tests.ps1 @@ -0,0 +1,21 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzPostgreSqlFlexibleServerCapabilitiesByLocation')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzPostgreSqlFlexibleServerCapabilitiesByLocation.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 'Get-AzPostgreSqlFlexibleServerCapabilitiesByLocation' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerCapabilitiesByServer.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerCapabilitiesByServer.Tests.ps1 new file mode 100644 index 000000000000..6c397081b9f2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerCapabilitiesByServer.Tests.ps1 @@ -0,0 +1,21 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzPostgreSqlFlexibleServerCapabilitiesByServer')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzPostgreSqlFlexibleServerCapabilitiesByServer.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 'Get-AzPostgreSqlFlexibleServerCapabilitiesByServer' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerCapturedLog.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerCapturedLog.Tests.ps1 new file mode 100644 index 000000000000..3e54ef1ae41d --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerCapturedLog.Tests.ps1 @@ -0,0 +1,21 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzPostgreSqlFlexibleServerCapturedLog')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzPostgreSqlFlexibleServerCapturedLog.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 'Get-AzPostgreSqlFlexibleServerCapturedLog' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerConfiguration.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerConfiguration.Tests.ps1 new file mode 100644 index 000000000000..6bec57cbfebb --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerConfiguration.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzPostgreSqlFlexibleServerConfiguration')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzPostgreSqlFlexibleServerConfiguration.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 'Get-AzPostgreSqlFlexibleServerConfiguration' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentityFlexibleServer' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerDatabase.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerDatabase.Tests.ps1 new file mode 100644 index 000000000000..20d364397fe3 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerDatabase.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzPostgreSqlFlexibleServerDatabase')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzPostgreSqlFlexibleServerDatabase.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 'Get-AzPostgreSqlFlexibleServerDatabase' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentityFlexibleServer' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerFirewallRule.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerFirewallRule.Tests.ps1 new file mode 100644 index 000000000000..8ee02d4269a9 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerFirewallRule.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzPostgreSqlFlexibleServerFirewallRule')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzPostgreSqlFlexibleServerFirewallRule.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 'Get-AzPostgreSqlFlexibleServerFirewallRule' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentityFlexibleServer' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerMigration.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerMigration.Tests.ps1 new file mode 100644 index 000000000000..b49776eef991 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerMigration.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzPostgreSqlFlexibleServerMigration')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzPostgreSqlFlexibleServerMigration.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 'Get-AzPostgreSqlFlexibleServerMigration' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentityFlexibleServer' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerPrivateDnsZoneSuffix.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerPrivateDnsZoneSuffix.Tests.ps1 new file mode 100644 index 000000000000..1d4e8076bbe3 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerPrivateDnsZoneSuffix.Tests.ps1 @@ -0,0 +1,21 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzPostgreSqlFlexibleServerPrivateDnsZoneSuffix')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzPostgreSqlFlexibleServerPrivateDnsZoneSuffix.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 'Get-AzPostgreSqlFlexibleServerPrivateDnsZoneSuffix' { + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerQuotaUsage.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerQuotaUsage.Tests.ps1 new file mode 100644 index 000000000000..7e987bc12d73 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerQuotaUsage.Tests.ps1 @@ -0,0 +1,21 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzPostgreSqlFlexibleServerQuotaUsage')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzPostgreSqlFlexibleServerQuotaUsage.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 'Get-AzPostgreSqlFlexibleServerQuotaUsage' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerReplica.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerReplica.Tests.ps1 new file mode 100644 index 000000000000..44fded3606cf --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerReplica.Tests.ps1 @@ -0,0 +1,21 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzPostgreSqlFlexibleServerReplica')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzPostgreSqlFlexibleServerReplica.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 'Get-AzPostgreSqlFlexibleServerReplica' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerTuningOption.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerTuningOption.Tests.ps1 new file mode 100644 index 000000000000..563726fddde3 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerTuningOption.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzPostgreSqlFlexibleServerTuningOption')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzPostgreSqlFlexibleServerTuningOption.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 'Get-AzPostgreSqlFlexibleServerTuningOption' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentityFlexibleServer' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerTuningOptionRecommendation.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerTuningOptionRecommendation.Tests.ps1 new file mode 100644 index 000000000000..b2a995668144 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerTuningOptionRecommendation.Tests.ps1 @@ -0,0 +1,21 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzPostgreSqlFlexibleServerTuningOptionRecommendation')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzPostgreSqlFlexibleServerTuningOptionRecommendation.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 'Get-AzPostgreSqlFlexibleServerTuningOptionRecommendation' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerVirtualEndpoint.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerVirtualEndpoint.Tests.ps1 new file mode 100644 index 000000000000..25febca01a34 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerVirtualEndpoint.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzPostgreSqlFlexibleServerVirtualEndpoint')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzPostgreSqlFlexibleServerVirtualEndpoint.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 'Get-AzPostgreSqlFlexibleServerVirtualEndpoint' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentityFlexibleServer' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerVirtualNetworkSubnetUsage.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerVirtualNetworkSubnetUsage.Tests.ps1 new file mode 100644 index 000000000000..4148cf032aef --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Get-AzPostgreSqlFlexibleServerVirtualNetworkSubnetUsage.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzPostgreSqlFlexibleServerVirtualNetworkSubnetUsage')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzPostgreSqlFlexibleServerVirtualNetworkSubnetUsage.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 'Get-AzPostgreSqlFlexibleServerVirtualNetworkSubnetUsage' { + It 'ListExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'ListViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'ListViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/New-AzPostgreSqlFlexibleServer.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/New-AzPostgreSqlFlexibleServer.Tests.ps1 new file mode 100644 index 000000000000..bdf54e48b053 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/New-AzPostgreSqlFlexibleServer.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'New-AzPostgreSqlFlexibleServer')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'New-AzPostgreSqlFlexibleServer.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-AzPostgreSqlFlexibleServer' { + It 'CreateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/New-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/New-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.Tests.ps1 new file mode 100644 index 000000000000..8c5dc20c8813 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/New-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'New-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'New-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.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-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra' { + It 'CreateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaIdentityFlexibleServerExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/New-AzPostgreSqlFlexibleServerDatabase.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/New-AzPostgreSqlFlexibleServerDatabase.Tests.ps1 new file mode 100644 index 000000000000..2c52d33416d5 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/New-AzPostgreSqlFlexibleServerDatabase.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'New-AzPostgreSqlFlexibleServerDatabase')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'New-AzPostgreSqlFlexibleServerDatabase.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-AzPostgreSqlFlexibleServerDatabase' { + It 'CreateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaIdentityFlexibleServerExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/New-AzPostgreSqlFlexibleServerFirewallRule.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/New-AzPostgreSqlFlexibleServerFirewallRule.Tests.ps1 new file mode 100644 index 000000000000..a21fec347da7 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/New-AzPostgreSqlFlexibleServerFirewallRule.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'New-AzPostgreSqlFlexibleServerFirewallRule')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'New-AzPostgreSqlFlexibleServerFirewallRule.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-AzPostgreSqlFlexibleServerFirewallRule' { + It 'CreateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaIdentityFlexibleServerExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/New-AzPostgreSqlFlexibleServerMigration.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/New-AzPostgreSqlFlexibleServerMigration.Tests.ps1 new file mode 100644 index 000000000000..1aa19790af09 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/New-AzPostgreSqlFlexibleServerMigration.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'New-AzPostgreSqlFlexibleServerMigration')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'New-AzPostgreSqlFlexibleServerMigration.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-AzPostgreSqlFlexibleServerMigration' { + It 'CreateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaIdentityFlexibleServerExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/New-AzPostgreSqlFlexibleServerThreatProtectionSetting.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/New-AzPostgreSqlFlexibleServerThreatProtectionSetting.Tests.ps1 new file mode 100644 index 000000000000..e967d194daf7 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/New-AzPostgreSqlFlexibleServerThreatProtectionSetting.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'New-AzPostgreSqlFlexibleServerThreatProtectionSetting')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'New-AzPostgreSqlFlexibleServerThreatProtectionSetting.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-AzPostgreSqlFlexibleServerThreatProtectionSetting' { + It 'CreateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/New-AzPostgreSqlFlexibleServerVirtualEndpoint.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/New-AzPostgreSqlFlexibleServerVirtualEndpoint.Tests.ps1 new file mode 100644 index 000000000000..99af2b8f7c27 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/New-AzPostgreSqlFlexibleServerVirtualEndpoint.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'New-AzPostgreSqlFlexibleServerVirtualEndpoint')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'New-AzPostgreSqlFlexibleServerVirtualEndpoint.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-AzPostgreSqlFlexibleServerVirtualEndpoint' { + It 'CreateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaIdentityFlexibleServerExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/README.md b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/README.md new file mode 100644 index 000000000000..7c752b4c8c43 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/README.md @@ -0,0 +1,17 @@ +# Test +This directory contains the [Pester](https://www.powershellgallery.com/packages/Pester) tests to run for the module. We use Pester as it is the unofficial standard for PowerShell unit testing. Test stubs for custom cmdlets (created in `..\custom`) will be generated into this folder when `build-module.ps1` is ran. These test stubs will fail automatically, to indicate that tests should be written for custom cmdlets. + +## Info +- Modifiable: yes +- Generated: partial +- Committed: yes +- Packaged: no + +## Details +We allow three testing modes: *live*, *record*, and *playback*. These can be selected using the `-Live`, `-Record`, and `-Playback` switches respectively on the `test-module.ps1` script. This script will run through any `.Tests.ps1` scripts in the `test` folder. If you choose the *record* mode, it will create a `.Recording.json` file of the REST calls between the client and server. Then, when you choose *playback* mode, it will use the `.Recording.json` file to mock the communication between server and client. The *live* mode runs the same as the *record* mode; however, it doesn't create the `.Recording.json` file. + +## Purpose +Custom cmdlets generally encompass additional functionality not described in the REST specification, or combines functionality generated from the REST spec. To validate this functionality continues to operate as intended, creating tests that can be ran and re-ran against custom cmdlets is part of the framework. + +## Usage +To execute tests, run the `test-module.ps1`. To write tests, [this example](https://github.com/pester/Pester/blob/8b9cf4248315e44f1ac6673be149f7e0d7f10466/Examples/Planets/Get-Planet.Tests.ps1#L1) from the Pester repository is very useful for getting started. \ No newline at end of file diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Remove-AzPostgreSqlFlexibleServer.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Remove-AzPostgreSqlFlexibleServer.Tests.ps1 new file mode 100644 index 000000000000..96d668c46644 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Remove-AzPostgreSqlFlexibleServer.Tests.ps1 @@ -0,0 +1,25 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Remove-AzPostgreSqlFlexibleServer')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Remove-AzPostgreSqlFlexibleServer.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 'Remove-AzPostgreSqlFlexibleServer' { + It 'Delete' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Remove-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Remove-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.Tests.ps1 new file mode 100644 index 000000000000..65b80af380db --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Remove-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Remove-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Remove-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.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 'Remove-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra' { + It 'Delete' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentityFlexibleServer' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Remove-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Remove-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand.Tests.ps1 new file mode 100644 index 000000000000..6e0ecb95de96 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Remove-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Remove-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Remove-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand.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 'Remove-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand' { + It 'Delete' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentityFlexibleServer' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Remove-AzPostgreSqlFlexibleServerDatabase.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Remove-AzPostgreSqlFlexibleServerDatabase.Tests.ps1 new file mode 100644 index 000000000000..a5cae9a5ac93 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Remove-AzPostgreSqlFlexibleServerDatabase.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Remove-AzPostgreSqlFlexibleServerDatabase')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Remove-AzPostgreSqlFlexibleServerDatabase.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 'Remove-AzPostgreSqlFlexibleServerDatabase' { + It 'Delete' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentityFlexibleServer' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Remove-AzPostgreSqlFlexibleServerFirewallRule.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Remove-AzPostgreSqlFlexibleServerFirewallRule.Tests.ps1 new file mode 100644 index 000000000000..dac1182ce7c6 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Remove-AzPostgreSqlFlexibleServerFirewallRule.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Remove-AzPostgreSqlFlexibleServerFirewallRule')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Remove-AzPostgreSqlFlexibleServerFirewallRule.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 'Remove-AzPostgreSqlFlexibleServerFirewallRule' { + It 'Delete' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentityFlexibleServer' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Remove-AzPostgreSqlFlexibleServerVirtualEndpoint.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Remove-AzPostgreSqlFlexibleServerVirtualEndpoint.Tests.ps1 new file mode 100644 index 000000000000..1c52e41144f5 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Remove-AzPostgreSqlFlexibleServerVirtualEndpoint.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Remove-AzPostgreSqlFlexibleServerVirtualEndpoint')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Remove-AzPostgreSqlFlexibleServerVirtualEndpoint.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 'Remove-AzPostgreSqlFlexibleServerVirtualEndpoint' { + It 'Delete' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentityFlexibleServer' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Restart-AzPostgreSqlFlexibleServer.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Restart-AzPostgreSqlFlexibleServer.Tests.ps1 new file mode 100644 index 000000000000..0ee5e19e544b --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Restart-AzPostgreSqlFlexibleServer.Tests.ps1 @@ -0,0 +1,41 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Restart-AzPostgreSqlFlexibleServer')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Restart-AzPostgreSqlFlexibleServer.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 'Restart-AzPostgreSqlFlexibleServer' { + It 'RestartExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'RestartViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'RestartViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Restart' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'RestartViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'RestartViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Start-AzPostgreSqlFlexibleServer.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Start-AzPostgreSqlFlexibleServer.Tests.ps1 new file mode 100644 index 000000000000..adf5e7a3752c --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Start-AzPostgreSqlFlexibleServer.Tests.ps1 @@ -0,0 +1,25 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Start-AzPostgreSqlFlexibleServer')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Start-AzPostgreSqlFlexibleServer.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 'Start-AzPostgreSqlFlexibleServer' { + It 'Start' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'StartViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention.Tests.ps1 new file mode 100644 index 000000000000..78213edd0098 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention.Tests.ps1 @@ -0,0 +1,41 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention.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 'Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention' { + It 'StartViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'StartViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'StartViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'StartExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Start' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'StartViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Stop-AzPostgreSqlFlexibleServer.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Stop-AzPostgreSqlFlexibleServer.Tests.ps1 new file mode 100644 index 000000000000..8baa0c7026ab --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Stop-AzPostgreSqlFlexibleServer.Tests.ps1 @@ -0,0 +1,25 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Stop-AzPostgreSqlFlexibleServer')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Stop-AzPostgreSqlFlexibleServer.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 'Stop-AzPostgreSqlFlexibleServer' { + It 'Stop' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'StopViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Stop-AzPostgreSqlFlexibleServerMigration.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Stop-AzPostgreSqlFlexibleServerMigration.Tests.ps1 new file mode 100644 index 000000000000..4b5dee8213c8 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Stop-AzPostgreSqlFlexibleServerMigration.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Stop-AzPostgreSqlFlexibleServerMigration')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Stop-AzPostgreSqlFlexibleServerMigration.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 'Stop-AzPostgreSqlFlexibleServerMigration' { + It 'Cancel' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CancelViaIdentityFlexibleServer' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CancelViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite.Tests.ps1 new file mode 100644 index 000000000000..2e5599d99430 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite.Tests.ps1 @@ -0,0 +1,41 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite.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 'Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite' { + It 'CheckExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CheckViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CheckViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Check' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CheckViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CheckViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Test-AzPostgreSqlFlexibleServerMigrationNameAvailability.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Test-AzPostgreSqlFlexibleServerMigrationNameAvailability.Tests.ps1 new file mode 100644 index 000000000000..dd0f47dfec92 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Test-AzPostgreSqlFlexibleServerMigrationNameAvailability.Tests.ps1 @@ -0,0 +1,41 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Test-AzPostgreSqlFlexibleServerMigrationNameAvailability')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Test-AzPostgreSqlFlexibleServerMigrationNameAvailability.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 'Test-AzPostgreSqlFlexibleServerMigrationNameAvailability' { + It 'CheckExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CheckViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CheckViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Check' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CheckViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CheckViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Test-AzPostgreSqlFlexibleServerNameAvailability.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Test-AzPostgreSqlFlexibleServerNameAvailability.Tests.ps1 new file mode 100644 index 000000000000..c32b7acd472c --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Test-AzPostgreSqlFlexibleServerNameAvailability.Tests.ps1 @@ -0,0 +1,41 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Test-AzPostgreSqlFlexibleServerNameAvailability')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Test-AzPostgreSqlFlexibleServerNameAvailability.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 'Test-AzPostgreSqlFlexibleServerNameAvailability' { + It 'CheckExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CheckViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CheckViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Check' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CheckViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CheckViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Test-AzPostgreSqlFlexibleServerNameAvailabilityGlobally.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Test-AzPostgreSqlFlexibleServerNameAvailabilityGlobally.Tests.ps1 new file mode 100644 index 000000000000..5bb86a8dcdea --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Test-AzPostgreSqlFlexibleServerNameAvailabilityGlobally.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Test-AzPostgreSqlFlexibleServerNameAvailabilityGlobally')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Test-AzPostgreSqlFlexibleServerNameAvailabilityGlobally.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 'Test-AzPostgreSqlFlexibleServerNameAvailabilityGlobally' { + It 'CheckExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Check' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CheckViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CheckViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Update-AzPostgreSqlFlexibleServer.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Update-AzPostgreSqlFlexibleServer.Tests.ps1 new file mode 100644 index 000000000000..2ce4cdfbb078 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Update-AzPostgreSqlFlexibleServer.Tests.ps1 @@ -0,0 +1,25 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Update-AzPostgreSqlFlexibleServer')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Update-AzPostgreSqlFlexibleServer.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 'Update-AzPostgreSqlFlexibleServer' { + It 'UpdateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Update-AzPostgreSqlFlexibleServerConfiguration.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Update-AzPostgreSqlFlexibleServerConfiguration.Tests.ps1 new file mode 100644 index 000000000000..3f2abecba8bf --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Update-AzPostgreSqlFlexibleServerConfiguration.Tests.ps1 @@ -0,0 +1,37 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Update-AzPostgreSqlFlexibleServerConfiguration')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Update-AzPostgreSqlFlexibleServerConfiguration.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 'Update-AzPostgreSqlFlexibleServerConfiguration' { + It 'UpdateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityFlexibleServerExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Update-AzPostgreSqlFlexibleServerDatabase.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Update-AzPostgreSqlFlexibleServerDatabase.Tests.ps1 new file mode 100644 index 000000000000..96a2bb4a8932 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Update-AzPostgreSqlFlexibleServerDatabase.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Update-AzPostgreSqlFlexibleServerDatabase')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Update-AzPostgreSqlFlexibleServerDatabase.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 'Update-AzPostgreSqlFlexibleServerDatabase' { + It 'UpdateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityFlexibleServerExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Update-AzPostgreSqlFlexibleServerFirewallRule.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Update-AzPostgreSqlFlexibleServerFirewallRule.Tests.ps1 new file mode 100644 index 000000000000..fcfa9c79b739 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Update-AzPostgreSqlFlexibleServerFirewallRule.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Update-AzPostgreSqlFlexibleServerFirewallRule')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Update-AzPostgreSqlFlexibleServerFirewallRule.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 'Update-AzPostgreSqlFlexibleServerFirewallRule' { + It 'UpdateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityFlexibleServerExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Update-AzPostgreSqlFlexibleServerMigration.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Update-AzPostgreSqlFlexibleServerMigration.Tests.ps1 new file mode 100644 index 000000000000..ff75398da0b3 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Update-AzPostgreSqlFlexibleServerMigration.Tests.ps1 @@ -0,0 +1,37 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Update-AzPostgreSqlFlexibleServerMigration')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Update-AzPostgreSqlFlexibleServerMigration.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 'Update-AzPostgreSqlFlexibleServerMigration' { + It 'UpdateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityFlexibleServerExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Update-AzPostgreSqlFlexibleServerVirtualEndpoint.Tests.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Update-AzPostgreSqlFlexibleServerVirtualEndpoint.Tests.ps1 new file mode 100644 index 000000000000..4745811d9a72 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/Update-AzPostgreSqlFlexibleServerVirtualEndpoint.Tests.ps1 @@ -0,0 +1,37 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Update-AzPostgreSqlFlexibleServerVirtualEndpoint')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Update-AzPostgreSqlFlexibleServerVirtualEndpoint.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 'Update-AzPostgreSqlFlexibleServerVirtualEndpoint' { + It 'UpdateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityFlexibleServerExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/loadEnv.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/loadEnv.ps1 new file mode 100644 index 000000000000..6a7c385c6b7d --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/loadEnv.ps1 @@ -0,0 +1,29 @@ +# ---------------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# http://www.apache.org/licenses/LICENSE-2.0 +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code +# is regenerated. +# ---------------------------------------------------------------------------------- +$envFile = 'env.json' +if ($TestMode -eq 'live') { + $envFile = 'localEnv.json' +} + +if (Test-Path -Path (Join-Path $PSScriptRoot $envFile)) { + $envFilePath = Join-Path $PSScriptRoot $envFile +} else { + $envFilePath = Join-Path $PSScriptRoot '..\$envFile' +} +$env = @{} +if (Test-Path -Path $envFilePath) { + $env = Get-Content (Join-Path $PSScriptRoot $envFile) | ConvertFrom-Json + $PSDefaultParameterValues=@{"*:Tenant"=$env.Tenant} +} \ No newline at end of file diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/utils.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/utils.ps1 new file mode 100644 index 000000000000..f8497fbd7da0 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/test/utils.ps1 @@ -0,0 +1,56 @@ +function RandomString([bool]$allChars, [int32]$len) { + if ($allChars) { + return -join ((33..126) | Get-Random -Count $len | % {[char]$_}) + } else { + return -join ((48..57) + (97..122) | Get-Random -Count $len | % {[char]$_}) + } +} +function Start-TestSleep { + [CmdletBinding(DefaultParameterSetName = 'SleepBySeconds')] + param( + [parameter(Mandatory = $true, Position = 0, ParameterSetName = 'SleepBySeconds')] + [ValidateRange(0.0, 2147483.0)] + [double] $Seconds, + + [parameter(Mandatory = $true, ParameterSetName = 'SleepByMilliseconds')] + [ValidateRange('NonNegative')] + [Alias('ms')] + [int] $Milliseconds + ) + + if ($TestMode -ne 'playback') { + switch ($PSCmdlet.ParameterSetName) { + 'SleepBySeconds' { + Start-Sleep -Seconds $Seconds + } + 'SleepByMilliseconds' { + Start-Sleep -Milliseconds $Milliseconds + } + } + } +} + +$env = @{} +if ($UsePreviousConfigForRecord) { + $previousEnv = Get-Content (Join-Path $PSScriptRoot 'env.json') | ConvertFrom-Json + $previousEnv.psobject.properties | Foreach-Object { $env[$_.Name] = $_.Value } +} +# Add script method called AddWithCache to $env, when useCache is set true, it will try to get the value from the $env first. +# example: $val = $env.AddWithCache('key', $val, $true) +$env | Add-Member -Type ScriptMethod -Value { param( [string]$key, [object]$val, [bool]$useCache) if ($this.Contains($key) -and $useCache) { return $this[$key] } else { $this[$key] = $val; return $val } } -Name 'AddWithCache' +function setupEnv() { + # Preload subscriptionId and tenant from context, which will be used in test + # as default. You could change them if needed. + $env.SubscriptionId = (Get-AzContext).Subscription.Id + $env.Tenant = (Get-AzContext).Tenant.Id + # For any resources you created for test, you should add it to $env here. + $envFile = 'env.json' + if ($TestMode -eq 'live') { + $envFile = 'localEnv.json' + } + set-content -Path (Join-Path $PSScriptRoot $envFile) -Value (ConvertTo-Json $env) +} +function cleanupEnv() { + # Clean resources you create for testing +} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/utils/Get-SubscriptionIdTestSafe.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/utils/Get-SubscriptionIdTestSafe.ps1 new file mode 100644 index 000000000000..5319862d3372 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/utils/Get-SubscriptionIdTestSafe.ps1 @@ -0,0 +1,7 @@ +param() +if ($env:AzPSAutorestTestPlaybackMode) { + $loadEnvPath = Join-Path $PSScriptRoot '..' 'test' 'loadEnv.ps1' + . ($loadEnvPath) + return $env.SubscriptionId +} +return (Get-AzContext).Subscription.Id \ No newline at end of file diff --git a/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/utils/Unprotect-SecureString.ps1 b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/utils/Unprotect-SecureString.ps1 new file mode 100644 index 000000000000..cb05b51a6220 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSQLFlexibleServer.Autorest/utils/Unprotect-SecureString.ps1 @@ -0,0 +1,16 @@ +#This script converts securestring to plaintext + +param( + [Parameter(Mandatory, ValueFromPipeline)] + [System.Security.SecureString] + ${SecureString} +) + +$ssPtr = [System.Runtime.InteropServices.Marshal]::SecureStringToBSTR($SecureString) +try { + $plaintext = [System.Runtime.InteropServices.Marshal]::PtrToStringBSTR($ssPtr) +} finally { + [System.Runtime.InteropServices.Marshal]::ZeroFreeBSTR($ssPtr) +} + +return $plaintext \ No newline at end of file diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer.sln b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer.sln new file mode 100644 index 000000000000..3908858531c9 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer.sln @@ -0,0 +1,145 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 17 +VisualStudioVersion = 17.0.31903.59 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Accounts", "Accounts", "{32836310-FB5E-5A92-56B4-44D826EF11F5}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Accounts", "..\Accounts\Accounts\Accounts.csproj", "{CD19A36E-8D8B-4DAD-9CF8-01EC88DDC255}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AssemblyLoading", "..\Accounts\AssemblyLoading\AssemblyLoading.csproj", "{56EE6018-68E8-4177-AD71-C0ADAFEC8343}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Authentication", "..\Accounts\Authentication\Authentication.csproj", "{4F1B9324-A35F-44B7-B8F0-93037B6F723B}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Authentication.ResourceManager", "..\Accounts\Authentication.ResourceManager\Authentication.ResourceManager.csproj", "{0AA0D91A-0886-4A6E-BC9D-DCF942F664F0}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AuthenticationAssemblyLoadContext", "..\Accounts\AuthenticationAssemblyLoadContext\AuthenticationAssemblyLoadContext.csproj", "{1164C8DE-DB6E-4296-9096-ED4BE09625FC}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Authenticators", "..\Accounts\Authenticators\Authenticators.csproj", "{9A181278-D9FF-4EAF-84AA-F2026D0B82B0}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "PostgreSqlFlexibleServer", "PostgreSqlFlexibleServer\PostgreSqlFlexibleServer.csproj", "{3ACDFC77-BCBE-47CC-B2EE-8F3DA9E84701}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "PostgreSQLFlexibleServer.Autorest", "PostgreSQLFlexibleServer.Autorest", "{4C14BC2F-C5CA-81E0-B3AD-B9EF19176EC4}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.PostgreSqlFlexibleServer", "..\..\generated\PostgreSqlFlexibleServer\PostgreSQLFlexibleServer.Autorest\Az.PostgreSqlFlexibleServer.csproj", "{7F0CA9B2-4033-4D20-93B4-58AE34D12A45}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Debug|x64 = Debug|x64 + Debug|x86 = Debug|x86 + Release|Any CPU = Release|Any CPU + Release|x64 = Release|x64 + Release|x86 = Release|x86 + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {CD19A36E-8D8B-4DAD-9CF8-01EC88DDC255}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {CD19A36E-8D8B-4DAD-9CF8-01EC88DDC255}.Debug|Any CPU.Build.0 = Debug|Any CPU + {CD19A36E-8D8B-4DAD-9CF8-01EC88DDC255}.Debug|x64.ActiveCfg = Debug|Any CPU + {CD19A36E-8D8B-4DAD-9CF8-01EC88DDC255}.Debug|x64.Build.0 = Debug|Any CPU + {CD19A36E-8D8B-4DAD-9CF8-01EC88DDC255}.Debug|x86.ActiveCfg = Debug|Any CPU + {CD19A36E-8D8B-4DAD-9CF8-01EC88DDC255}.Debug|x86.Build.0 = Debug|Any CPU + {CD19A36E-8D8B-4DAD-9CF8-01EC88DDC255}.Release|Any CPU.ActiveCfg = Release|Any CPU + {CD19A36E-8D8B-4DAD-9CF8-01EC88DDC255}.Release|Any CPU.Build.0 = Release|Any CPU + {CD19A36E-8D8B-4DAD-9CF8-01EC88DDC255}.Release|x64.ActiveCfg = Release|Any CPU + {CD19A36E-8D8B-4DAD-9CF8-01EC88DDC255}.Release|x64.Build.0 = Release|Any CPU + {CD19A36E-8D8B-4DAD-9CF8-01EC88DDC255}.Release|x86.ActiveCfg = Release|Any CPU + {CD19A36E-8D8B-4DAD-9CF8-01EC88DDC255}.Release|x86.Build.0 = Release|Any CPU + {56EE6018-68E8-4177-AD71-C0ADAFEC8343}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {56EE6018-68E8-4177-AD71-C0ADAFEC8343}.Debug|Any CPU.Build.0 = Debug|Any CPU + {56EE6018-68E8-4177-AD71-C0ADAFEC8343}.Debug|x64.ActiveCfg = Debug|Any CPU + {56EE6018-68E8-4177-AD71-C0ADAFEC8343}.Debug|x64.Build.0 = Debug|Any CPU + {56EE6018-68E8-4177-AD71-C0ADAFEC8343}.Debug|x86.ActiveCfg = Debug|Any CPU + {56EE6018-68E8-4177-AD71-C0ADAFEC8343}.Debug|x86.Build.0 = Debug|Any CPU + {56EE6018-68E8-4177-AD71-C0ADAFEC8343}.Release|Any CPU.ActiveCfg = Release|Any CPU + {56EE6018-68E8-4177-AD71-C0ADAFEC8343}.Release|Any CPU.Build.0 = Release|Any CPU + {56EE6018-68E8-4177-AD71-C0ADAFEC8343}.Release|x64.ActiveCfg = Release|Any CPU + {56EE6018-68E8-4177-AD71-C0ADAFEC8343}.Release|x64.Build.0 = Release|Any CPU + {56EE6018-68E8-4177-AD71-C0ADAFEC8343}.Release|x86.ActiveCfg = Release|Any CPU + {56EE6018-68E8-4177-AD71-C0ADAFEC8343}.Release|x86.Build.0 = Release|Any CPU + {4F1B9324-A35F-44B7-B8F0-93037B6F723B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {4F1B9324-A35F-44B7-B8F0-93037B6F723B}.Debug|Any CPU.Build.0 = Debug|Any CPU + {4F1B9324-A35F-44B7-B8F0-93037B6F723B}.Debug|x64.ActiveCfg = Debug|Any CPU + {4F1B9324-A35F-44B7-B8F0-93037B6F723B}.Debug|x64.Build.0 = Debug|Any CPU + {4F1B9324-A35F-44B7-B8F0-93037B6F723B}.Debug|x86.ActiveCfg = Debug|Any CPU + {4F1B9324-A35F-44B7-B8F0-93037B6F723B}.Debug|x86.Build.0 = Debug|Any CPU + {4F1B9324-A35F-44B7-B8F0-93037B6F723B}.Release|Any CPU.ActiveCfg = Release|Any CPU + {4F1B9324-A35F-44B7-B8F0-93037B6F723B}.Release|Any CPU.Build.0 = Release|Any CPU + {4F1B9324-A35F-44B7-B8F0-93037B6F723B}.Release|x64.ActiveCfg = Release|Any CPU + {4F1B9324-A35F-44B7-B8F0-93037B6F723B}.Release|x64.Build.0 = Release|Any CPU + {4F1B9324-A35F-44B7-B8F0-93037B6F723B}.Release|x86.ActiveCfg = Release|Any CPU + {4F1B9324-A35F-44B7-B8F0-93037B6F723B}.Release|x86.Build.0 = Release|Any CPU + {0AA0D91A-0886-4A6E-BC9D-DCF942F664F0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {0AA0D91A-0886-4A6E-BC9D-DCF942F664F0}.Debug|Any CPU.Build.0 = Debug|Any CPU + {0AA0D91A-0886-4A6E-BC9D-DCF942F664F0}.Debug|x64.ActiveCfg = Debug|Any CPU + {0AA0D91A-0886-4A6E-BC9D-DCF942F664F0}.Debug|x64.Build.0 = Debug|Any CPU + {0AA0D91A-0886-4A6E-BC9D-DCF942F664F0}.Debug|x86.ActiveCfg = Debug|Any CPU + {0AA0D91A-0886-4A6E-BC9D-DCF942F664F0}.Debug|x86.Build.0 = Debug|Any CPU + {0AA0D91A-0886-4A6E-BC9D-DCF942F664F0}.Release|Any CPU.ActiveCfg = Release|Any CPU + {0AA0D91A-0886-4A6E-BC9D-DCF942F664F0}.Release|Any CPU.Build.0 = Release|Any CPU + {0AA0D91A-0886-4A6E-BC9D-DCF942F664F0}.Release|x64.ActiveCfg = Release|Any CPU + {0AA0D91A-0886-4A6E-BC9D-DCF942F664F0}.Release|x64.Build.0 = Release|Any CPU + {0AA0D91A-0886-4A6E-BC9D-DCF942F664F0}.Release|x86.ActiveCfg = Release|Any CPU + {0AA0D91A-0886-4A6E-BC9D-DCF942F664F0}.Release|x86.Build.0 = Release|Any CPU + {1164C8DE-DB6E-4296-9096-ED4BE09625FC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {1164C8DE-DB6E-4296-9096-ED4BE09625FC}.Debug|Any CPU.Build.0 = Debug|Any CPU + {1164C8DE-DB6E-4296-9096-ED4BE09625FC}.Debug|x64.ActiveCfg = Debug|Any CPU + {1164C8DE-DB6E-4296-9096-ED4BE09625FC}.Debug|x64.Build.0 = Debug|Any CPU + {1164C8DE-DB6E-4296-9096-ED4BE09625FC}.Debug|x86.ActiveCfg = Debug|Any CPU + {1164C8DE-DB6E-4296-9096-ED4BE09625FC}.Debug|x86.Build.0 = Debug|Any CPU + {1164C8DE-DB6E-4296-9096-ED4BE09625FC}.Release|Any CPU.ActiveCfg = Release|Any CPU + {1164C8DE-DB6E-4296-9096-ED4BE09625FC}.Release|Any CPU.Build.0 = Release|Any CPU + {1164C8DE-DB6E-4296-9096-ED4BE09625FC}.Release|x64.ActiveCfg = Release|Any CPU + {1164C8DE-DB6E-4296-9096-ED4BE09625FC}.Release|x64.Build.0 = Release|Any CPU + {1164C8DE-DB6E-4296-9096-ED4BE09625FC}.Release|x86.ActiveCfg = Release|Any CPU + {1164C8DE-DB6E-4296-9096-ED4BE09625FC}.Release|x86.Build.0 = Release|Any CPU + {9A181278-D9FF-4EAF-84AA-F2026D0B82B0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {9A181278-D9FF-4EAF-84AA-F2026D0B82B0}.Debug|Any CPU.Build.0 = Debug|Any CPU + {9A181278-D9FF-4EAF-84AA-F2026D0B82B0}.Debug|x64.ActiveCfg = Debug|Any CPU + {9A181278-D9FF-4EAF-84AA-F2026D0B82B0}.Debug|x64.Build.0 = Debug|Any CPU + {9A181278-D9FF-4EAF-84AA-F2026D0B82B0}.Debug|x86.ActiveCfg = Debug|Any CPU + {9A181278-D9FF-4EAF-84AA-F2026D0B82B0}.Debug|x86.Build.0 = Debug|Any CPU + {9A181278-D9FF-4EAF-84AA-F2026D0B82B0}.Release|Any CPU.ActiveCfg = Release|Any CPU + {9A181278-D9FF-4EAF-84AA-F2026D0B82B0}.Release|Any CPU.Build.0 = Release|Any CPU + {9A181278-D9FF-4EAF-84AA-F2026D0B82B0}.Release|x64.ActiveCfg = Release|Any CPU + {9A181278-D9FF-4EAF-84AA-F2026D0B82B0}.Release|x64.Build.0 = Release|Any CPU + {9A181278-D9FF-4EAF-84AA-F2026D0B82B0}.Release|x86.ActiveCfg = Release|Any CPU + {9A181278-D9FF-4EAF-84AA-F2026D0B82B0}.Release|x86.Build.0 = Release|Any CPU + {3ACDFC77-BCBE-47CC-B2EE-8F3DA9E84701}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {3ACDFC77-BCBE-47CC-B2EE-8F3DA9E84701}.Debug|Any CPU.Build.0 = Debug|Any CPU + {3ACDFC77-BCBE-47CC-B2EE-8F3DA9E84701}.Debug|x64.ActiveCfg = Debug|Any CPU + {3ACDFC77-BCBE-47CC-B2EE-8F3DA9E84701}.Debug|x64.Build.0 = Debug|Any CPU + {3ACDFC77-BCBE-47CC-B2EE-8F3DA9E84701}.Debug|x86.ActiveCfg = Debug|Any CPU + {3ACDFC77-BCBE-47CC-B2EE-8F3DA9E84701}.Debug|x86.Build.0 = Debug|Any CPU + {3ACDFC77-BCBE-47CC-B2EE-8F3DA9E84701}.Release|Any CPU.ActiveCfg = Release|Any CPU + {3ACDFC77-BCBE-47CC-B2EE-8F3DA9E84701}.Release|Any CPU.Build.0 = Release|Any CPU + {3ACDFC77-BCBE-47CC-B2EE-8F3DA9E84701}.Release|x64.ActiveCfg = Release|Any CPU + {3ACDFC77-BCBE-47CC-B2EE-8F3DA9E84701}.Release|x64.Build.0 = Release|Any CPU + {3ACDFC77-BCBE-47CC-B2EE-8F3DA9E84701}.Release|x86.ActiveCfg = Release|Any CPU + {3ACDFC77-BCBE-47CC-B2EE-8F3DA9E84701}.Release|x86.Build.0 = Release|Any CPU + {7F0CA9B2-4033-4D20-93B4-58AE34D12A45}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {7F0CA9B2-4033-4D20-93B4-58AE34D12A45}.Debug|Any CPU.Build.0 = Debug|Any CPU + {7F0CA9B2-4033-4D20-93B4-58AE34D12A45}.Debug|x64.ActiveCfg = Debug|Any CPU + {7F0CA9B2-4033-4D20-93B4-58AE34D12A45}.Debug|x64.Build.0 = Debug|Any CPU + {7F0CA9B2-4033-4D20-93B4-58AE34D12A45}.Debug|x86.ActiveCfg = Debug|Any CPU + {7F0CA9B2-4033-4D20-93B4-58AE34D12A45}.Debug|x86.Build.0 = Debug|Any CPU + {7F0CA9B2-4033-4D20-93B4-58AE34D12A45}.Release|Any CPU.ActiveCfg = Release|Any CPU + {7F0CA9B2-4033-4D20-93B4-58AE34D12A45}.Release|Any CPU.Build.0 = Release|Any CPU + {7F0CA9B2-4033-4D20-93B4-58AE34D12A45}.Release|x64.ActiveCfg = Release|Any CPU + {7F0CA9B2-4033-4D20-93B4-58AE34D12A45}.Release|x64.Build.0 = Release|Any CPU + {7F0CA9B2-4033-4D20-93B4-58AE34D12A45}.Release|x86.ActiveCfg = Release|Any CPU + {7F0CA9B2-4033-4D20-93B4-58AE34D12A45}.Release|x86.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(NestedProjects) = preSolution + {CD19A36E-8D8B-4DAD-9CF8-01EC88DDC255} = {32836310-FB5E-5A92-56B4-44D826EF11F5} + {56EE6018-68E8-4177-AD71-C0ADAFEC8343} = {32836310-FB5E-5A92-56B4-44D826EF11F5} + {4F1B9324-A35F-44B7-B8F0-93037B6F723B} = {32836310-FB5E-5A92-56B4-44D826EF11F5} + {0AA0D91A-0886-4A6E-BC9D-DCF942F664F0} = {32836310-FB5E-5A92-56B4-44D826EF11F5} + {1164C8DE-DB6E-4296-9096-ED4BE09625FC} = {32836310-FB5E-5A92-56B4-44D826EF11F5} + {9A181278-D9FF-4EAF-84AA-F2026D0B82B0} = {32836310-FB5E-5A92-56B4-44D826EF11F5} + {7F0CA9B2-4033-4D20-93B4-58AE34D12A45} = {4C14BC2F-C5CA-81E0-B3AD-B9EF19176EC4} + EndGlobalSection +EndGlobal diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/Az.PostgreSqlFlexibleServer.psd1 b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/Az.PostgreSqlFlexibleServer.psd1 new file mode 100644 index 000000000000..f0fef63c937f --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/Az.PostgreSqlFlexibleServer.psd1 @@ -0,0 +1,180 @@ +# +# Module manifest for module 'Az.PostgreSqlFlexibleServer' +# +# Generated by: Microsoft Corporation +# +# Generated on: 1/7/2026 +# + +@{ + +# Script module or binary module file associated with this manifest. +# RootModule = '' + +# Version number of this module. +ModuleVersion = '0.1.0' + +# Supported PSEditions +CompatiblePSEditions = 'Core', 'Desktop' + +# ID used to uniquely identify this module +GUID = 'accceef6-8113-453a-a31c-4f2ce57893d6' + +# 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: PostgreSqlFlexibleServer 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 = '5.3.1'; }) + +# Assemblies that must be loaded prior to importing this module +RequiredAssemblies = + 'PostgreSQLFlexibleServer.Autorest/bin/Az.PostgreSqlFlexibleServer.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 = + 'PostgreSQLFlexibleServer.Autorest/Az.PostgreSqlFlexibleServer.format.ps1xml' + +# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess +NestedModules = @('PostgreSQLFlexibleServer.Autorest/Az.PostgreSqlFlexibleServer.psm1') + +# 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-AzPostgreSqlFlexibleServer', + 'Get-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra', + 'Get-AzPostgreSqlFlexibleServerAdvancedThreatProtectionSetting', + 'Get-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand', + 'Get-AzPostgreSqlFlexibleServerBackupsLongTermRetention', + 'Get-AzPostgreSqlFlexibleServerCapabilitiesByLocation', + 'Get-AzPostgreSqlFlexibleServerCapabilitiesByServer', + 'Get-AzPostgreSqlFlexibleServerCapturedLog', + 'Get-AzPostgreSqlFlexibleServerConfiguration', + 'Get-AzPostgreSqlFlexibleServerDatabase', + 'Get-AzPostgreSqlFlexibleServerFirewallRule', + 'Get-AzPostgreSqlFlexibleServerMigration', + 'Get-AzPostgreSqlFlexibleServerPrivateDnsZoneSuffix', + 'Get-AzPostgreSqlFlexibleServerQuotaUsage', + 'Get-AzPostgreSqlFlexibleServerReplica', + 'Get-AzPostgreSqlFlexibleServerTuningOption', + 'Get-AzPostgreSqlFlexibleServerTuningOptionRecommendation', + 'Get-AzPostgreSqlFlexibleServerVirtualEndpoint', + 'Get-AzPostgreSqlFlexibleServerVirtualNetworkSubnetUsage', + 'New-AzPostgreSqlFlexibleServer', + 'New-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra', + 'New-AzPostgreSqlFlexibleServerDatabase', + 'New-AzPostgreSqlFlexibleServerFirewallRule', + 'New-AzPostgreSqlFlexibleServerMigration', + 'New-AzPostgreSqlFlexibleServerThreatProtectionSetting', + 'New-AzPostgreSqlFlexibleServerVirtualEndpoint', + 'Remove-AzPostgreSqlFlexibleServer', + 'Remove-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra', + 'Remove-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand', + 'Remove-AzPostgreSqlFlexibleServerDatabase', + 'Remove-AzPostgreSqlFlexibleServerFirewallRule', + 'Remove-AzPostgreSqlFlexibleServerVirtualEndpoint', + 'Restart-AzPostgreSqlFlexibleServer', + 'Start-AzPostgreSqlFlexibleServer', + 'Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention', + 'Stop-AzPostgreSqlFlexibleServer', + 'Stop-AzPostgreSqlFlexibleServerMigration', + 'Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite', + 'Test-AzPostgreSqlFlexibleServerMigrationNameAvailability', + 'Test-AzPostgreSqlFlexibleServerNameAvailability', + 'Test-AzPostgreSqlFlexibleServerNameAvailabilityGlobally', + 'Update-AzPostgreSqlFlexibleServer', + 'Update-AzPostgreSqlFlexibleServerConfiguration', + 'Update-AzPostgreSqlFlexibleServerDatabase', + 'Update-AzPostgreSqlFlexibleServerFirewallRule', + 'Update-AzPostgreSqlFlexibleServerMigration', + 'Update-AzPostgreSqlFlexibleServerVirtualEndpoint' + +# 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 = @{ + + PSData = @{ + + # Tags applied to this module. These help with module discovery in online galleries. + Tags = 'Azure', 'ResourceManager', 'ARM', 'PSModule', 'PostgreSqlFlexibleServer' + + # 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 = '' + + # 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 = '' + +} + diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/ChangeLog.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/ChangeLog.md new file mode 100644 index 000000000000..47be8117cc99 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/ChangeLog.md @@ -0,0 +1,24 @@ + +## Upcoming Release + +## Version 0.1.0 +* First preview release for module Az.PostgreSqlFlexibleServer + diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/PostgreSqlFlexibleServer.csproj b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/PostgreSqlFlexibleServer.csproj new file mode 100644 index 000000000000..5a043d9f8f32 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/PostgreSqlFlexibleServer.csproj @@ -0,0 +1,28 @@ + + + + + + + PostgreSqlFlexibleServer + + + + netstandard2.0 + $(AzAssemblyPrefix)$(PsModuleName) + $(AzAssemblyPrefix)$(PsModuleName) + true + false + $(RepoArtifacts)$(Configuration)\Az.$(PsModuleName)\ + $(OutputPath) + + + + + + + + + + + diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/Properties/AssemblyInfo.cs b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/Properties/AssemblyInfo.cs new file mode 100644 index 000000000000..b1b3c3c3e223 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/Properties/AssemblyInfo.cs @@ -0,0 +1,28 @@ +// ---------------------------------------------------------------------------------- +// +// Copyright Microsoft Corporation +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// http://www.apache.org/licenses/LICENSE-2.0 +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// ---------------------------------------------------------------------------------- + +using System; +using System.Reflection; +using System.Runtime.InteropServices; + +[assembly: AssemblyTitle("Microsoft Azure Powershell - PostgreSqlFlexibleServer")] +[assembly: AssemblyCompany(Microsoft.WindowsAzure.Commands.Common.AzurePowerShell.AssemblyCompany)] +[assembly: AssemblyProduct(Microsoft.WindowsAzure.Commands.Common.AzurePowerShell.AssemblyProduct)] +[assembly: AssemblyCopyright(Microsoft.WindowsAzure.Commands.Common.AzurePowerShell.AssemblyCopyright)] + +[assembly: ComVisible(false)] +[assembly: CLSCompliant(false)] +[assembly: Guid("92860d57-bfad-4502-a922-ed0f353bac8b")] +[assembly: AssemblyVersion("0.1.0")] +[assembly: AssemblyFileVersion("0.1.0")] diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Az.PostgreSqlFlexibleServer.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Az.PostgreSqlFlexibleServer.md new file mode 100644 index 000000000000..09a0092e72ce --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Az.PostgreSqlFlexibleServer.md @@ -0,0 +1,156 @@ +--- +Module Name: Az.PostgreSqlFlexibleServer +Module Guid: accceef6-8113-453a-a31c-4f2ce57893d6 +Download Help Link: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver +Help Version: 1.0.0.0 +Locale: en-US +--- + +# Az.PostgreSqlFlexibleServer Module +## Description +Microsoft Azure PowerShell: PostgreSqlFlexibleServer cmdlets + +## Az.PostgreSqlFlexibleServer Cmdlets +### [Get-AzPostgreSqlFlexibleServer](Get-AzPostgreSqlFlexibleServer.md) +Gets information about an existing server. + +### [Get-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra](Get-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md) +Gets information about a server administrator associated to a Microsoft Entra principal. + +### [Get-AzPostgreSqlFlexibleServerAdvancedThreatProtectionSetting](Get-AzPostgreSqlFlexibleServerAdvancedThreatProtectionSetting.md) +Gets state of advanced threat protection settings for a server. + +### [Get-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand](Get-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand.md) +Gets information of an on demand backup, given its name. + +### [Get-AzPostgreSqlFlexibleServerBackupsLongTermRetention](Get-AzPostgreSqlFlexibleServerBackupsLongTermRetention.md) +Gets the results of a long retention backup operation for a server. + +### [Get-AzPostgreSqlFlexibleServerCapabilitiesByLocation](Get-AzPostgreSqlFlexibleServerCapabilitiesByLocation.md) +Lists the capabilities available in a given location for a specific subscription. + +### [Get-AzPostgreSqlFlexibleServerCapabilitiesByServer](Get-AzPostgreSqlFlexibleServerCapabilitiesByServer.md) +Lists the capabilities available for a given server. + +### [Get-AzPostgreSqlFlexibleServerCapturedLog](Get-AzPostgreSqlFlexibleServerCapturedLog.md) +Lists all captured logs for download in a server. + +### [Get-AzPostgreSqlFlexibleServerConfiguration](Get-AzPostgreSqlFlexibleServerConfiguration.md) +Gets information about a specific configuration (also known as server parameter) of a server. + +### [Get-AzPostgreSqlFlexibleServerDatabase](Get-AzPostgreSqlFlexibleServerDatabase.md) +Gets information about an existing database. + +### [Get-AzPostgreSqlFlexibleServerFirewallRule](Get-AzPostgreSqlFlexibleServerFirewallRule.md) +Gets information about a firewall rule in a server. + +### [Get-AzPostgreSqlFlexibleServerMigration](Get-AzPostgreSqlFlexibleServerMigration.md) +Gets information about a migration. + +### [Get-AzPostgreSqlFlexibleServerPrivateDnsZoneSuffix](Get-AzPostgreSqlFlexibleServerPrivateDnsZoneSuffix.md) +Gets the private DNS zone suffix. + +### [Get-AzPostgreSqlFlexibleServerQuotaUsage](Get-AzPostgreSqlFlexibleServerQuotaUsage.md) +Get quota usages at specified location in a given subscription. + +### [Get-AzPostgreSqlFlexibleServerReplica](Get-AzPostgreSqlFlexibleServerReplica.md) +Lists all read replicas of a server. + +### [Get-AzPostgreSqlFlexibleServerTuningOption](Get-AzPostgreSqlFlexibleServerTuningOption.md) +Gets the tuning options of a server. + +### [Get-AzPostgreSqlFlexibleServerTuningOptionRecommendation](Get-AzPostgreSqlFlexibleServerTuningOptionRecommendation.md) +Lists available object recommendations. + +### [Get-AzPostgreSqlFlexibleServerVirtualEndpoint](Get-AzPostgreSqlFlexibleServerVirtualEndpoint.md) +Gets information about a pair of virtual endpoints. + +### [Get-AzPostgreSqlFlexibleServerVirtualNetworkSubnetUsage](Get-AzPostgreSqlFlexibleServerVirtualNetworkSubnetUsage.md) +Lists the virtual network subnet usage for a given virtual network. + +### [New-AzPostgreSqlFlexibleServer](New-AzPostgreSqlFlexibleServer.md) +Create a new server. + +### [New-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra](New-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md) +Create a new server administrator associated to a Microsoft Entra principal. + +### [New-AzPostgreSqlFlexibleServerDatabase](New-AzPostgreSqlFlexibleServerDatabase.md) +Create a new database. + +### [New-AzPostgreSqlFlexibleServerFirewallRule](New-AzPostgreSqlFlexibleServerFirewallRule.md) +Create a new firewall rule or create an existing firewall rule. + +### [New-AzPostgreSqlFlexibleServerMigration](New-AzPostgreSqlFlexibleServerMigration.md) +Create a new migration. + +### [New-AzPostgreSqlFlexibleServerThreatProtectionSetting](New-AzPostgreSqlFlexibleServerThreatProtectionSetting.md) +Create a server's Advanced Threat Protection settings. + +### [New-AzPostgreSqlFlexibleServerVirtualEndpoint](New-AzPostgreSqlFlexibleServerVirtualEndpoint.md) +Create a pair of virtual endpoints for a server. + +### [Remove-AzPostgreSqlFlexibleServer](Remove-AzPostgreSqlFlexibleServer.md) +Deletes or drops an existing server. + +### [Remove-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra](Remove-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md) +Deletes an existing server administrator associated to a Microsoft Entra principal. + +### [Remove-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand](Remove-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand.md) +Deletes a specific backup, given its name. + +### [Remove-AzPostgreSqlFlexibleServerDatabase](Remove-AzPostgreSqlFlexibleServerDatabase.md) +Deletes an existing database. + +### [Remove-AzPostgreSqlFlexibleServerFirewallRule](Remove-AzPostgreSqlFlexibleServerFirewallRule.md) +Deletes an existing firewall rule. + +### [Remove-AzPostgreSqlFlexibleServerVirtualEndpoint](Remove-AzPostgreSqlFlexibleServerVirtualEndpoint.md) +Deletes a pair of virtual endpoints. + +### [Restart-AzPostgreSqlFlexibleServer](Restart-AzPostgreSqlFlexibleServer.md) +Restarts PostgreSQL database engine in a server. + +### [Start-AzPostgreSqlFlexibleServer](Start-AzPostgreSqlFlexibleServer.md) +Starts a stopped server. + +### [Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention](Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention.md) +Initiates a long term retention backup. + +### [Stop-AzPostgreSqlFlexibleServer](Stop-AzPostgreSqlFlexibleServer.md) +Stops a server. + +### [Stop-AzPostgreSqlFlexibleServerMigration](Stop-AzPostgreSqlFlexibleServerMigration.md) +Cancels an active migration. + +### [Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite](Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite.md) +Performs all checks required for a long term retention backup operation to succeed. + +### [Test-AzPostgreSqlFlexibleServerMigrationNameAvailability](Test-AzPostgreSqlFlexibleServerMigrationNameAvailability.md) +Checks if a proposed migration name is valid and available. + +### [Test-AzPostgreSqlFlexibleServerNameAvailability](Test-AzPostgreSqlFlexibleServerNameAvailability.md) +Check the availability of name for resource + +### [Test-AzPostgreSqlFlexibleServerNameAvailabilityGlobally](Test-AzPostgreSqlFlexibleServerNameAvailabilityGlobally.md) +Checks the validity and availability of the given name, to assign it to a new server or to use it as the base name of a new pair of virtual endpoints. + +### [Update-AzPostgreSqlFlexibleServer](Update-AzPostgreSqlFlexibleServer.md) +Update a new server. + +### [Update-AzPostgreSqlFlexibleServerConfiguration](Update-AzPostgreSqlFlexibleServerConfiguration.md) +Update the value assigned to a specific modifiable configuration (also known as server parameter) of a server. + +### [Update-AzPostgreSqlFlexibleServerDatabase](Update-AzPostgreSqlFlexibleServerDatabase.md) +Update a new database. + +### [Update-AzPostgreSqlFlexibleServerFirewallRule](Update-AzPostgreSqlFlexibleServerFirewallRule.md) +Update a new firewall rule or update an existing firewall rule. + +### [Update-AzPostgreSqlFlexibleServerMigration](Update-AzPostgreSqlFlexibleServerMigration.md) +Update an existing migration. +The request body can contain one to many of the mutable properties present in the migration definition. +Certain property update initiate migration state transitions. + +### [Update-AzPostgreSqlFlexibleServerVirtualEndpoint](Update-AzPostgreSqlFlexibleServerVirtualEndpoint.md) +Update a pair of virtual endpoints for a server. + diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServer.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServer.md new file mode 100644 index 000000000000..d7f60e45d0bd --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServer.md @@ -0,0 +1,159 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleserver +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServer + +## SYNOPSIS +Gets information about an existing server. + +## SYNTAX + +### List (Default) +``` +Get-AzPostgreSqlFlexibleServer [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzPostgreSqlFlexibleServer -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### List1 +``` +Get-AzPostgreSqlFlexibleServer -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlFlexibleServer -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Gets information about an existing server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +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 server. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: ServerName + +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. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: List, Get, 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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IServer + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md new file mode 100644 index 000000000000..47bdbeb6b9a9 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md @@ -0,0 +1,192 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleserveradministratorsmicrosoftentra +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra + +## SYNOPSIS +Gets information about a server administrator associated to a Microsoft Entra principal. + +## SYNTAX + +### List (Default) +``` +Get-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetViaIdentityFlexibleServer +``` +Get-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra -ObjectId + -FlexibleServerInputObject [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra -ObjectId -ResourceGroupName + -ServerName [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra -InputObject + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets information about a server administrator associated to a Microsoft Entra principal. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentityFlexibleServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ObjectId +Object identifier of the Microsoft Entra principal. + +```yaml +Type: System.String +Parameter Sets: GetViaIdentityFlexibleServer, Get +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: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IAdministratorMicrosoftEntra + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerAdvancedThreatProtectionSetting.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerAdvancedThreatProtectionSetting.md new file mode 100644 index 000000000000..127af9daf50a --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerAdvancedThreatProtectionSetting.md @@ -0,0 +1,155 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleserveradvancedthreatprotectionsetting +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerAdvancedThreatProtectionSetting + +## SYNOPSIS +Gets state of advanced threat protection settings for a server. + +## SYNTAX + +### Get (Default) +``` +Get-AzPostgreSqlFlexibleServerAdvancedThreatProtectionSetting -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### List +``` +Get-AzPostgreSqlFlexibleServerAdvancedThreatProtectionSetting -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlFlexibleServerAdvancedThreatProtectionSetting -InputObject + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets state of advanced threat protection settings for a server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentity +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: Get, List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```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. +The value must be an UUID. + +```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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IAdvancedThreatProtectionSettingsModel + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand.md new file mode 100644 index 000000000000..0ac4a6c1816e --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand.md @@ -0,0 +1,192 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleserverbackupsautomaticandondemand +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand + +## SYNOPSIS +Gets information of an on demand backup, given its name. + +## SYNTAX + +### List (Default) +``` +Get-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetViaIdentityFlexibleServer +``` +Get-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand -BackupName + -FlexibleServerInputObject [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand -BackupName -ResourceGroupName + -ServerName [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand -InputObject + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets information of an on demand backup, given its name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -BackupName +Name of the backup. + +```yaml +Type: System.String +Parameter Sets: GetViaIdentityFlexibleServer, Get +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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentityFlexibleServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentity +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: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IBackupAutomaticAndOnDemand + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerBackupsLongTermRetention.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerBackupsLongTermRetention.md new file mode 100644 index 000000000000..a0879f183ef7 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerBackupsLongTermRetention.md @@ -0,0 +1,192 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleserverbackupslongtermretention +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerBackupsLongTermRetention + +## SYNOPSIS +Gets the results of a long retention backup operation for a server. + +## SYNTAX + +### List (Default) +``` +Get-AzPostgreSqlFlexibleServerBackupsLongTermRetention -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetViaIdentityFlexibleServer +``` +Get-AzPostgreSqlFlexibleServerBackupsLongTermRetention -BackupName + -FlexibleServerInputObject [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzPostgreSqlFlexibleServerBackupsLongTermRetention -BackupName -ResourceGroupName + -ServerName [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlFlexibleServerBackupsLongTermRetention -InputObject + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets the results of a long retention backup operation for a server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -BackupName +The name of the backup. + +```yaml +Type: System.String +Parameter Sets: GetViaIdentityFlexibleServer, Get +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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentityFlexibleServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentity +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: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IBackupsLongTermRetentionOperation + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerCapabilitiesByLocation.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerCapabilitiesByLocation.md new file mode 100644 index 000000000000..6ea13794f7c7 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerCapabilitiesByLocation.md @@ -0,0 +1,107 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleservercapabilitiesbylocation +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerCapabilitiesByLocation + +## SYNOPSIS +Lists the capabilities available in a given location for a specific subscription. + +## SYNTAX + +``` +Get-AzPostgreSqlFlexibleServerCapabilitiesByLocation -LocationName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Lists the capabilities available in a given location for a specific subscription. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -LocationName +The name of the location. + +```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. +The value must be an UUID. + +```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 +``` + +### 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 + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.ICapability + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerCapabilitiesByServer.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerCapabilitiesByServer.md new file mode 100644 index 000000000000..642e23126a06 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerCapabilitiesByServer.md @@ -0,0 +1,124 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleservercapabilitiesbyserver +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerCapabilitiesByServer + +## SYNOPSIS +Lists the capabilities available for a given server. + +## SYNTAX + +``` +Get-AzPostgreSqlFlexibleServerCapabilitiesByServer -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Lists the capabilities available for a given server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -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 +``` + +### -ServerName +The name of 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 +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```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 +``` + +### 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 + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.ICapability + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerCapturedLog.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerCapturedLog.md new file mode 100644 index 000000000000..6a0821684beb --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerCapturedLog.md @@ -0,0 +1,124 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleservercapturedlog +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerCapturedLog + +## SYNOPSIS +Lists all captured logs for download in a server. + +## SYNTAX + +``` +Get-AzPostgreSqlFlexibleServerCapturedLog -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Lists all captured logs for download in a server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -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 +``` + +### -ServerName +The name of 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 +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```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 +``` + +### 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 + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.ICapturedLog + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerConfiguration.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerConfiguration.md new file mode 100644 index 000000000000..5a7b432594a2 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerConfiguration.md @@ -0,0 +1,192 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleserverconfiguration +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerConfiguration + +## SYNOPSIS +Gets information about a specific configuration (also known as server parameter) of a server. + +## SYNTAX + +### List (Default) +``` +Get-AzPostgreSqlFlexibleServerConfiguration -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetViaIdentityFlexibleServer +``` +Get-AzPostgreSqlFlexibleServerConfiguration -Name + -FlexibleServerInputObject [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzPostgreSqlFlexibleServerConfiguration -Name -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlFlexibleServerConfiguration -InputObject + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets information about a specific configuration (also known as server parameter) of a server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentityFlexibleServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the configuration (also known as server parameter). + +```yaml +Type: System.String +Parameter Sets: GetViaIdentityFlexibleServer, Get +Aliases: ConfigurationName + +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: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IConfiguration + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerDatabase.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerDatabase.md new file mode 100644 index 000000000000..0b9c3f713bd8 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerDatabase.md @@ -0,0 +1,193 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleserverdatabase +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerDatabase + +## SYNOPSIS +Gets information about an existing database. + +## SYNTAX + +### List (Default) +``` +Get-AzPostgreSqlFlexibleServerDatabase -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetViaIdentityFlexibleServer +``` +Get-AzPostgreSqlFlexibleServerDatabase -Name + -FlexibleServerInputObject [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzPostgreSqlFlexibleServerDatabase -Name -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlFlexibleServerDatabase -InputObject + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets information about an existing database. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentityFlexibleServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the database (case-sensitive). +Exact database names can be retrieved by getting the list of all existing databases in a server. + +```yaml +Type: System.String +Parameter Sets: GetViaIdentityFlexibleServer, Get +Aliases: DatabaseName + +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: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IDatabase + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerFirewallRule.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerFirewallRule.md new file mode 100644 index 000000000000..cd470ef1abe0 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerFirewallRule.md @@ -0,0 +1,192 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleserverfirewallrule +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerFirewallRule + +## SYNOPSIS +Gets information about a firewall rule in a server. + +## SYNTAX + +### List (Default) +``` +Get-AzPostgreSqlFlexibleServerFirewallRule -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetViaIdentityFlexibleServer +``` +Get-AzPostgreSqlFlexibleServerFirewallRule -Name + -FlexibleServerInputObject [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzPostgreSqlFlexibleServerFirewallRule -Name -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlFlexibleServerFirewallRule -InputObject + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets information about a firewall rule in a server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentityFlexibleServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the firewall rule. + +```yaml +Type: System.String +Parameter Sets: GetViaIdentityFlexibleServer, Get +Aliases: FirewallRuleName + +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: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IFirewallRule + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerMigration.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerMigration.md new file mode 100644 index 000000000000..a48dc0e6da02 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerMigration.md @@ -0,0 +1,209 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleservermigration +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerMigration + +## SYNOPSIS +Gets information about a migration. + +## SYNTAX + +### List (Default) +``` +Get-AzPostgreSqlFlexibleServerMigration -ResourceGroupName -ServerName + [-SubscriptionId ] [-MigrationListFilter ] [-DefaultProfile ] + [] +``` + +### GetViaIdentityFlexibleServer +``` +Get-AzPostgreSqlFlexibleServerMigration -Name + -FlexibleServerInputObject [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzPostgreSqlFlexibleServerMigration -Name -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlFlexibleServerMigration -InputObject + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets information about a migration. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentityFlexibleServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MigrationListFilter +Migration list filter. +Indicates if the request should retrieve only active migrations or all migrations. +Defaults to Active. + +```yaml +Type: System.String +Parameter Sets: List +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of migration. + +```yaml +Type: System.String +Parameter Sets: GetViaIdentityFlexibleServer, Get +Aliases: MigrationName + +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: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IMigration + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerPrivateDnsZoneSuffix.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerPrivateDnsZoneSuffix.md new file mode 100644 index 000000000000..9362c413e94f --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerPrivateDnsZoneSuffix.md @@ -0,0 +1,107 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleserverprivatednszonesuffix +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerPrivateDnsZoneSuffix + +## SYNOPSIS +Gets the private DNS zone suffix. + +## SYNTAX + +``` +Get-AzPostgreSqlFlexibleServerPrivateDnsZoneSuffix [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Gets the private DNS zone suffix. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -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 + +## OUTPUTS + +### System.String + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerQuotaUsage.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerQuotaUsage.md new file mode 100644 index 000000000000..ba6763d7096e --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerQuotaUsage.md @@ -0,0 +1,107 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleserverquotausage +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerQuotaUsage + +## SYNOPSIS +Get quota usages at specified location in a given subscription. + +## SYNTAX + +``` +Get-AzPostgreSqlFlexibleServerQuotaUsage -LocationName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get quota usages at specified location in a given subscription. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -LocationName +The name of the location. + +```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. +The value must be an UUID. + +```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 +``` + +### 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 + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IQuotaUsage + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerReplica.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerReplica.md new file mode 100644 index 000000000000..e13da684c0a3 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerReplica.md @@ -0,0 +1,124 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleserverreplica +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerReplica + +## SYNOPSIS +Lists all read replicas of a server. + +## SYNTAX + +``` +Get-AzPostgreSqlFlexibleServerReplica -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Lists all read replicas of a server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -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 +``` + +### -ServerName +The name of 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 +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```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 +``` + +### 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 + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IServer + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerTuningOption.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerTuningOption.md new file mode 100644 index 000000000000..f38e2c761a9d --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerTuningOption.md @@ -0,0 +1,192 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleservertuningoption +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerTuningOption + +## SYNOPSIS +Gets the tuning options of a server. + +## SYNTAX + +### List (Default) +``` +Get-AzPostgreSqlFlexibleServerTuningOption -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzPostgreSqlFlexibleServerTuningOption -ResourceGroupName -ServerName + [-SubscriptionId ] -TuningOption [-DefaultProfile ] + [] +``` + +### GetViaIdentityFlexibleServer +``` +Get-AzPostgreSqlFlexibleServerTuningOption -TuningOption + -FlexibleServerInputObject [-DefaultProfile ] + [] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlFlexibleServerTuningOption -InputObject + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets the tuning options of a server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentityFlexibleServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentity +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: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TuningOption +The name of the tuning option. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityFlexibleServer +Aliases: + +Required: True +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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.ITuningOptions + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerTuningOptionRecommendation.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerTuningOptionRecommendation.md new file mode 100644 index 000000000000..01dac5ee681f --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerTuningOptionRecommendation.md @@ -0,0 +1,155 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleservertuningoptionrecommendation +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerTuningOptionRecommendation + +## SYNOPSIS +Lists available object recommendations. + +## SYNTAX + +``` +Get-AzPostgreSqlFlexibleServerTuningOptionRecommendation -ResourceGroupName -ServerName + -TuningOption [-SubscriptionId ] [-RecommendationType ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Lists available object recommendations. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -RecommendationType +Recommendations list filter. +Retrieves recommendations based on type. + +```yaml +Type: System.String +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 +``` + +### -ServerName +The name of 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 +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```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 +``` + +### -TuningOption +The name of the tuning option. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +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 + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IObjectRecommendation + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerVirtualEndpoint.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerVirtualEndpoint.md new file mode 100644 index 000000000000..a424bd0d04cb --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerVirtualEndpoint.md @@ -0,0 +1,192 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleservervirtualendpoint +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerVirtualEndpoint + +## SYNOPSIS +Gets information about a pair of virtual endpoints. + +## SYNTAX + +### List (Default) +``` +Get-AzPostgreSqlFlexibleServerVirtualEndpoint -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetViaIdentityFlexibleServer +``` +Get-AzPostgreSqlFlexibleServerVirtualEndpoint -Name + -FlexibleServerInputObject [-DefaultProfile ] + [] +``` + +### Get +``` +Get-AzPostgreSqlFlexibleServerVirtualEndpoint -Name -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] + [] +``` + +### GetViaIdentity +``` +Get-AzPostgreSqlFlexibleServerVirtualEndpoint -InputObject + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets information about a pair of virtual endpoints. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentityFlexibleServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Base name of the virtual endpoints. + +```yaml +Type: System.String +Parameter Sets: GetViaIdentityFlexibleServer, Get +Aliases: VirtualEndpointName + +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: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: List, Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: List, Get +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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IVirtualEndpoint + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerVirtualNetworkSubnetUsage.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerVirtualNetworkSubnetUsage.md new file mode 100644 index 000000000000..48419b5aa2b0 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Get-AzPostgreSqlFlexibleServerVirtualNetworkSubnetUsage.md @@ -0,0 +1,223 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/get-azpostgresqlflexibleservervirtualnetworksubnetusage +schema: 2.0.0 +--- + +# Get-AzPostgreSqlFlexibleServerVirtualNetworkSubnetUsage + +## SYNOPSIS +Lists the virtual network subnet usage for a given virtual network. + +## SYNTAX + +### ListExpanded (Default) +``` +Get-AzPostgreSqlFlexibleServerVirtualNetworkSubnetUsage -LocationName [-SubscriptionId ] + [-VirtualNetworkArmResourceId ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### List +``` +Get-AzPostgreSqlFlexibleServerVirtualNetworkSubnetUsage -LocationName [-SubscriptionId ] + -Parameter [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### ListViaJsonFilePath +``` +Get-AzPostgreSqlFlexibleServerVirtualNetworkSubnetUsage -LocationName [-SubscriptionId ] + -JsonFilePath [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### ListViaJsonString +``` +Get-AzPostgreSqlFlexibleServerVirtualNetworkSubnetUsage -LocationName [-SubscriptionId ] + -JsonString [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Lists the virtual network subnet usage for a given virtual network. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -JsonFilePath +Path of Json file supplied to the List operation + +```yaml +Type: System.String +Parameter Sets: ListViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the List operation + +```yaml +Type: System.String +Parameter Sets: ListViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationName +The name of the location. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Virtual network subnet usage parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IVirtualNetworkSubnetUsageParameter +Parameter Sets: List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```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 +``` + +### -VirtualNetworkArmResourceId +Virtual network resource id. + +```yaml +Type: System.String +Parameter Sets: ListExpanded +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.PostgreSqlFlexibleServer.Models.IVirtualNetworkSubnetUsageParameter + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IVirtualNetworkSubnetUsageModel + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/New-AzPostgreSqlFlexibleServer.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/New-AzPostgreSqlFlexibleServer.md new file mode 100644 index 000000000000..4e3d562697b4 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/New-AzPostgreSqlFlexibleServer.md @@ -0,0 +1,830 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/new-azpostgresqlflexibleserver +schema: 2.0.0 +--- + +# New-AzPostgreSqlFlexibleServer + +## SYNOPSIS +Create a new server. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzPostgreSqlFlexibleServer -Name -ResourceGroupName [-SubscriptionId ] + -Location [-AdministratorLogin ] [-AdministratorLoginPassword ] + [-AuthConfigActiveDirectoryAuth ] [-AuthConfigPasswordAuth ] [-AuthConfigTenantId ] + [-AvailabilityZone ] [-BackupGeoRedundantBackup ] [-BackupRetentionDay ] + [-ClusterDefaultDatabaseName ] [-ClusterSize ] [-CreateMode ] + [-DataEncryptionGeoBackupKeyUri ] [-DataEncryptionGeoBackupUserAssignedIdentityId ] + [-DataEncryptionPrimaryKeyUri ] [-DataEncryptionPrimaryUserAssignedIdentityId ] + [-DataEncryptionType ] [-EnableSystemAssignedIdentity] [-HighAvailabilityMode ] + [-HighAvailabilityStandbyAvailabilityZone ] [-IdentityPrincipalId ] + [-NetworkDelegatedSubnetResourceId ] [-NetworkPrivateDnsZoneArmResourceId ] + [-NetworkPublicNetworkAccess ] [-PointInTimeUtc ] [-ReplicationRole ] + [-SkuName ] [-SkuTier ] [-SourceServerResourceId ] [-StorageAutoGrow ] + [-StorageIop ] [-StorageSizeGb ] [-StorageThroughput ] [-StorageTier ] + [-StorageType ] [-Tag ] [-UserAssignedIdentity ] [-Version ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### CreateViaJsonFilePath +``` +New-AzPostgreSqlFlexibleServer -Name -ResourceGroupName [-SubscriptionId ] + -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonString +``` +New-AzPostgreSqlFlexibleServer -Name -ResourceGroupName [-SubscriptionId ] + -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Create a new server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AdministratorLogin +Name of the login designated as the first password based administrator assigned to your instance of PostgreSQL. +Must be specified the first time that you enable password based authentication on a server. +Once set to a given value, it cannot be changed for the rest of the life of a server. +If you disable password based authentication on a server which had it enabled, this password based role isn't deleted. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdministratorLoginPassword +Password assigned to the administrator login. +As long as password authentication is enabled, this password can be changed at any time. + +```yaml +Type: System.Security.SecureString +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -AuthConfigActiveDirectoryAuth +Indicates if the server supports Microsoft Entra authentication. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthConfigPasswordAuth +Indicates if the server supports password based authentication. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthConfigTenantId +Identifier of the tenant of the delegated resource. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AvailabilityZone +Availability zone of a server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupGeoRedundantBackup +Indicates if the server is configured to create geographically redundant backups. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupRetentionDay +Backup retention days for the server. + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterDefaultDatabaseName +Default database name for the elastic cluster. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterSize +Number of nodes assigned to the elastic cluster. + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreateMode +Creation mode of a new server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataEncryptionGeoBackupKeyUri +Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a server that is configured to support geographically redundant backups. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataEncryptionGeoBackupUserAssignedIdentityId +Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a server that is configured to support geographically redundant backups. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataEncryptionPrimaryKeyUri +URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataEncryptionPrimaryUserAssignedIdentityId +Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the primary storage associated to a server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataEncryptionType +Data encryption type used by a server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +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 +``` + +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighAvailabilityMode +High availability mode for a server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighAvailabilityStandbyAvailabilityZone +Availability zone associated to the standby server created when high availability is set to SameZone or ZoneRedundant. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityPrincipalId +Identifier of the object of the service principal associated to the user assigned managed identity. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +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 server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkDelegatedSubnetResourceId +Resource identifier of the delegated subnet. +Required during creation of a new server, in case you want the server to be integrated into your own virtual network. +For an update operation, you only have to provide this property if you want to change the value assigned for the private DNS zone. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkPrivateDnsZoneArmResourceId +Identifier of the private DNS zone. +Required during creation of a new server, in case you want the server to be integrated into your own virtual network. +For an update operation, you only have to provide this property if you want to change the value assigned for the private DNS zone. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkPublicNetworkAccess +Indicates if public network access is enabled or not. +This is only supported for servers that are not integrated into a virtual network which is owned and provided by customer when server is deployed. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +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 +``` + +### -PointInTimeUtc +Creation time (in ISO8601 format) of the backup which you want to restore in the new server. +It's required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', or 'ReviveDropped'. + +```yaml +Type: System.DateTime +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationRole +Role of the server in a replication set. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +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 +``` + +### -SkuName +Name by which is known a given compute size assigned to a server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +Tier of the compute assigned to a server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceServerResourceId +Identifier of the server to be used as the source of the new server. +Required when 'createMode' is 'PointInTimeRestore', 'GeoRestore', 'Replica', or 'ReviveDropped'. +This property is returned only when the target server is a read replica. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAutoGrow +Flag to enable or disable the automatic growth of storage size of a server when available space is nearing zero and conditions allow for automatically growing storage size. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageIop +Maximum IOPS supported for storage. +Required when type of storage is PremiumV2_LRS or UltraSSD_LRS. + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageSizeGb +Size of storage assigned to a server. + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageThroughput +Maximum throughput supported for storage. +Required when type of storage is PremiumV2_LRS or UltraSSD_LRS. + +```yaml +Type: System.Int32 +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageTier +Storage tier of a server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageType +Type of storage assigned to a server. +Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. +If not specified, it defaults to Premium_LRS. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```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 +``` + +### -UserAssignedIdentity +The array of user assigned identities associated with the resource. +The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.' + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Major version of PostgreSQL database engine. + +```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 + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IServer + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/New-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/New-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md new file mode 100644 index 000000000000..cd2c035c2ca6 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/New-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md @@ -0,0 +1,316 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/new-azpostgresqlflexibleserveradministratorsmicrosoftentra +schema: 2.0.0 +--- + +# New-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra + +## SYNOPSIS +Create a new server administrator associated to a Microsoft Entra principal. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra -ObjectId -ResourceGroupName + -ServerName [-SubscriptionId ] [-PrincipalName ] [-PrincipalType ] + [-TenantId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonString +``` +New-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra -ObjectId -ResourceGroupName + -ServerName [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonFilePath +``` +New-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra -ObjectId -ResourceGroupName + -ServerName [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### CreateViaIdentityFlexibleServerExpanded +``` +New-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra -ObjectId + -FlexibleServerInputObject [-PrincipalName ] + [-PrincipalType ] [-TenantId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Create a new server administrator associated to a Microsoft Entra principal. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +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 +``` + +### -ObjectId +Object identifier of the Microsoft Entra principal. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalName +Name of the Microsoft Entra principal. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrincipalType +Type of Microsoft Entra principal to which the server administrator is associated. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +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: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TenantId +Identifier of the tenant in which the Microsoft Entra principal exists. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IAdministratorMicrosoftEntra + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/New-AzPostgreSqlFlexibleServerDatabase.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/New-AzPostgreSqlFlexibleServerDatabase.md new file mode 100644 index 000000000000..6cee0f193f03 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/New-AzPostgreSqlFlexibleServerDatabase.md @@ -0,0 +1,301 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/new-azpostgresqlflexibleserverdatabase +schema: 2.0.0 +--- + +# New-AzPostgreSqlFlexibleServerDatabase + +## SYNOPSIS +Create a new database. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzPostgreSqlFlexibleServerDatabase -Name -ResourceGroupName -ServerName + [-SubscriptionId ] [-Charset ] [-Collation ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonString +``` +New-AzPostgreSqlFlexibleServerDatabase -Name -ResourceGroupName -ServerName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonFilePath +``` +New-AzPostgreSqlFlexibleServerDatabase -Name -ResourceGroupName -ServerName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaIdentityFlexibleServerExpanded +``` +New-AzPostgreSqlFlexibleServerDatabase -Name + -FlexibleServerInputObject [-Charset ] [-Collation ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Create a new database. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -Charset +Character set of the database. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Collation +Collation of the database. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the database (case-sensitive). +Exact database names can be retrieved by getting the list of all existing databases in a server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: DatabaseName + +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 +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IDatabase + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/New-AzPostgreSqlFlexibleServerFirewallRule.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/New-AzPostgreSqlFlexibleServerFirewallRule.md new file mode 100644 index 000000000000..0fc825f4a6e5 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/New-AzPostgreSqlFlexibleServerFirewallRule.md @@ -0,0 +1,302 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/new-azpostgresqlflexibleserverfirewallrule +schema: 2.0.0 +--- + +# New-AzPostgreSqlFlexibleServerFirewallRule + +## SYNOPSIS +Create a new firewall rule or create an existing firewall rule. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzPostgreSqlFlexibleServerFirewallRule -Name -ResourceGroupName -ServerName + [-SubscriptionId ] -EndIPAddress -StartIPAddress [-DefaultProfile ] + [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonString +``` +New-AzPostgreSqlFlexibleServerFirewallRule -Name -ResourceGroupName -ServerName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonFilePath +``` +New-AzPostgreSqlFlexibleServerFirewallRule -Name -ResourceGroupName -ServerName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaIdentityFlexibleServerExpanded +``` +New-AzPostgreSqlFlexibleServerFirewallRule -Name + -FlexibleServerInputObject -EndIPAddress -StartIPAddress + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Create a new firewall rule or create an existing firewall rule. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -EndIPAddress +IP address defining the end of the range of addresses of a firewall rule. +Must be expressed in IPv4 format. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the firewall rule. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: FirewallRuleName + +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 +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartIPAddress +IP address defining the start of the range of addresses of a firewall rule. +Must be expressed in IPv4 format. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IFirewallRule + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/New-AzPostgreSqlFlexibleServerMigration.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/New-AzPostgreSqlFlexibleServerMigration.md new file mode 100644 index 000000000000..fade137cfb97 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/New-AzPostgreSqlFlexibleServerMigration.md @@ -0,0 +1,642 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/new-azpostgresqlflexibleservermigration +schema: 2.0.0 +--- + +# New-AzPostgreSqlFlexibleServerMigration + +## SYNOPSIS +Create a new migration. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzPostgreSqlFlexibleServerMigration -Name -ResourceGroupName -ServerName + [-SubscriptionId ] -Location [-AdminCredentialsSourceServerPassword ] + [-AdminCredentialsTargetServerPassword ] [-Cancel ] [-DbsToCancelMigrationOn ] + [-DbsToMigrate ] [-DbsToTriggerCutoverOn ] [-MigrateRole ] + [-MigrationInstanceResourceId ] [-MigrationMode ] [-MigrationOption ] + [-MigrationWindowEndTimeInUtc ] [-MigrationWindowStartTimeInUtc ] + [-OverwriteDbsInTarget ] [-SecretParameterSourceServerUsername ] + [-SecretParameterTargetServerUsername ] [-SetupLogicalReplicationOnSourceDbIfNeeded ] + [-SourceDbServerFullyQualifiedDomainName ] [-SourceDbServerResourceId ] [-SourceType ] + [-SslMode ] [-StartDataMigration ] [-Tag ] + [-TargetDbServerFullyQualifiedDomainName ] [-TriggerCutover ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonString +``` +New-AzPostgreSqlFlexibleServerMigration -Name -ResourceGroupName -ServerName + [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonFilePath +``` +New-AzPostgreSqlFlexibleServerMigration -Name -ResourceGroupName -ServerName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaIdentityFlexibleServerExpanded +``` +New-AzPostgreSqlFlexibleServerMigration -Name + -FlexibleServerInputObject -Location + [-AdminCredentialsSourceServerPassword ] [-AdminCredentialsTargetServerPassword ] + [-Cancel ] [-DbsToCancelMigrationOn ] [-DbsToMigrate ] + [-DbsToTriggerCutoverOn ] [-MigrateRole ] [-MigrationInstanceResourceId ] + [-MigrationMode ] [-MigrationOption ] [-MigrationWindowEndTimeInUtc ] + [-MigrationWindowStartTimeInUtc ] [-OverwriteDbsInTarget ] + [-SecretParameterSourceServerUsername ] [-SecretParameterTargetServerUsername ] + [-SetupLogicalReplicationOnSourceDbIfNeeded ] [-SourceDbServerFullyQualifiedDomainName ] + [-SourceDbServerResourceId ] [-SourceType ] [-SslMode ] [-StartDataMigration ] + [-Tag ] [-TargetDbServerFullyQualifiedDomainName ] [-TriggerCutover ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Create a new migration. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AdminCredentialsSourceServerPassword +Password for the user of the source server. + +```yaml +Type: System.Security.SecureString +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminCredentialsTargetServerPassword +Password for the user of the target server. + +```yaml +Type: System.Security.SecureString +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Cancel +Indicates if cancel must be triggered for the entire migration. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DbsToCancelMigrationOn +When you want to trigger cancel for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array. + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DbsToMigrate +Names of databases to migrate. + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DbsToTriggerCutoverOn +When you want to trigger cutover for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array. + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +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, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrateRole +Indicates if roles and permissions must be migrated. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationInstanceResourceId +Identifier of the private endpoint migration instance. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationMode +Mode used to perform the migration: Online or Offline. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationOption +Supported option for a migration. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationWindowEndTimeInUtc +End time (UTC) for migration window. + +```yaml +Type: System.DateTime +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationWindowStartTimeInUtc +Start time (UTC) for migration window. + +```yaml +Type: System.DateTime +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of migration. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: MigrationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverwriteDbsInTarget +Indicates if databases on the target server can be overwritten when already present. +If set to 'False', when the migration workflow detects that the database already exists on the target server, it will wait for a confirmation. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +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: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretParameterSourceServerUsername +Gets or sets the name of the user for the source server. +This user doesn't need to be an administrator. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretParameterTargetServerUsername +Gets or sets the name of the user for the target server. +This user doesn't need to be an administrator. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SetupLogicalReplicationOnSourceDbIfNeeded +Indicates whether to setup logical replication on source server, if needed. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceDbServerFullyQualifiedDomainName +Fully qualified domain name (FQDN) or IP address of the source server. +This property is optional. +When provided, the migration service will always use it to connect to the source server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceDbServerResourceId +Identifier of the source database server resource, when 'sourceType' is 'PostgreSQLSingleServer'. +For other source types this must be set to ipaddress:port@username or hostname:port@username. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceType +Source server type used for the migration: ApsaraDB_RDS, AWS, AWS_AURORA, AWS_EC2, AWS_RDS, AzureVM, Crunchy_PostgreSQL, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, EDB, EDB_Oracle_Server, EDB_PostgreSQL, GCP, GCP_AlloyDB, GCP_CloudSQL, GCP_Compute, Heroku_PostgreSQL, Huawei_Compute, Huawei_RDS, OnPremises, PostgreSQLCosmosDB, PostgreSQLFlexibleServer, PostgreSQLSingleServer, or Supabase_PostgreSQL + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslMode +SSL mode used by a migration. +Default SSL mode for 'PostgreSQLSingleServer' is 'VerifyFull'. +Default SSL mode for other source types is 'Prefer'. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDataMigration +Indicates if data migration must start right away. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +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, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDbServerFullyQualifiedDomainName +Fully qualified domain name (FQDN) or IP address of the target server. +This property is optional. +When provided, the migration service will always use it to connect to the target server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggerCutover +Indicates if cutover must be triggered for the entire migration. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IMigration + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/New-AzPostgreSqlFlexibleServerThreatProtectionSetting.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/New-AzPostgreSqlFlexibleServerThreatProtectionSetting.md new file mode 100644 index 000000000000..39a885c3f279 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/New-AzPostgreSqlFlexibleServerThreatProtectionSetting.md @@ -0,0 +1,245 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/new-azpostgresqlflexibleserverthreatprotectionsetting +schema: 2.0.0 +--- + +# New-AzPostgreSqlFlexibleServerThreatProtectionSetting + +## SYNOPSIS +Create a server's Advanced Threat Protection settings. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzPostgreSqlFlexibleServerThreatProtectionSetting -ResourceGroupName -ServerName + [-SubscriptionId ] [-State ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonFilePath +``` +New-AzPostgreSqlFlexibleServerThreatProtectionSetting -ResourceGroupName -ServerName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonString +``` +New-AzPostgreSqlFlexibleServerThreatProtectionSetting -ResourceGroupName -ServerName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Create a server's Advanced Threat Protection settings. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +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 +``` + +### -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 +``` + +### -ServerName +The name of 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 +``` + +### -State +Specifies the state of the advanced threat protection, whether it is enabled, disabled, or a state has not been applied yet on the server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```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 + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IAdvancedThreatProtectionSettingsModel + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/New-AzPostgreSqlFlexibleServerVirtualEndpoint.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/New-AzPostgreSqlFlexibleServerVirtualEndpoint.md new file mode 100644 index 000000000000..0fe9bf5672e5 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/New-AzPostgreSqlFlexibleServerVirtualEndpoint.md @@ -0,0 +1,300 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/new-azpostgresqlflexibleservervirtualendpoint +schema: 2.0.0 +--- + +# New-AzPostgreSqlFlexibleServerVirtualEndpoint + +## SYNOPSIS +Create a pair of virtual endpoints for a server. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzPostgreSqlFlexibleServerVirtualEndpoint -Name -ResourceGroupName -ServerName + [-SubscriptionId ] [-EndpointType ] [-Member ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonString +``` +New-AzPostgreSqlFlexibleServerVirtualEndpoint -Name -ResourceGroupName -ServerName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonFilePath +``` +New-AzPostgreSqlFlexibleServerVirtualEndpoint -Name -ResourceGroupName -ServerName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaIdentityFlexibleServerExpanded +``` +New-AzPostgreSqlFlexibleServerVirtualEndpoint -Name + -FlexibleServerInputObject [-EndpointType ] [-Member ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Create a pair of virtual endpoints for a server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -EndpointType +Type of endpoint for the virtual endpoints. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Member +List of servers that one of the virtual endpoints can refer to. + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded, CreateViaIdentityFlexibleServerExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Base name of the virtual endpoints. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: VirtualEndpointName + +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 +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath +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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IVirtualEndpoint + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Remove-AzPostgreSqlFlexibleServer.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Remove-AzPostgreSqlFlexibleServer.md new file mode 100644 index 000000000000..5e433109ef4d --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Remove-AzPostgreSqlFlexibleServer.md @@ -0,0 +1,224 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/remove-azpostgresqlflexibleserver +schema: 2.0.0 +--- + +# Remove-AzPostgreSqlFlexibleServer + +## SYNOPSIS +Deletes or drops an existing server. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPostgreSqlFlexibleServer -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + +### DeleteViaIdentity +``` +Remove-AzPostgreSqlFlexibleServer -InputObject [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Deletes or drops an existing server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +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 server. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: ServerName + +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. +The value must be an UUID. + +```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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Remove-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Remove-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md new file mode 100644 index 000000000000..44b5d0adfed4 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Remove-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra.md @@ -0,0 +1,262 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/remove-azpostgresqlflexibleserveradministratorsmicrosoftentra +schema: 2.0.0 +--- + +# Remove-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra + +## SYNOPSIS +Deletes an existing server administrator associated to a Microsoft Entra principal. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra -ObjectId -ResourceGroupName + -ServerName [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentityFlexibleServer +``` +Remove-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra -ObjectId + -FlexibleServerInputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentity +``` +Remove-AzPostgreSqlFlexibleServerAdministratorsMicrosoftEntra -InputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +Deletes an existing server administrator associated to a Microsoft Entra principal. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: DeleteViaIdentityFlexibleServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 +``` + +### -ObjectId +Object identifier of the Microsoft Entra principal. + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityFlexibleServer +Aliases: + +Required: True +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 +``` + +### -ServerName +The name of the server. + +```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. +The value must be an UUID. + +```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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Remove-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Remove-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand.md new file mode 100644 index 000000000000..52dd0e0891b0 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Remove-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand.md @@ -0,0 +1,262 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/remove-azpostgresqlflexibleserverbackupsautomaticandondemand +schema: 2.0.0 +--- + +# Remove-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand + +## SYNOPSIS +Deletes a specific backup, given its name. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand -BackupName -ResourceGroupName + -ServerName [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentityFlexibleServer +``` +Remove-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand -BackupName + -FlexibleServerInputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentity +``` +Remove-AzPostgreSqlFlexibleServerBackupsAutomaticAndOnDemand -InputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +Deletes a specific backup, given its name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -BackupName +Name of the backup. + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityFlexibleServer +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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: DeleteViaIdentityFlexibleServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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 +``` + +### -ServerName +The name of the server. + +```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. +The value must be an UUID. + +```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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Remove-AzPostgreSqlFlexibleServerDatabase.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Remove-AzPostgreSqlFlexibleServerDatabase.md new file mode 100644 index 000000000000..9313bdf9f2e9 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Remove-AzPostgreSqlFlexibleServerDatabase.md @@ -0,0 +1,263 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/remove-azpostgresqlflexibleserverdatabase +schema: 2.0.0 +--- + +# Remove-AzPostgreSqlFlexibleServerDatabase + +## SYNOPSIS +Deletes an existing database. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPostgreSqlFlexibleServerDatabase -Name -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentityFlexibleServer +``` +Remove-AzPostgreSqlFlexibleServerDatabase -Name + -FlexibleServerInputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentity +``` +Remove-AzPostgreSqlFlexibleServerDatabase -InputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +Deletes an existing database. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: DeleteViaIdentityFlexibleServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the database (case-sensitive). +Exact database names can be retrieved by getting the list of all existing databases in a server. + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityFlexibleServer +Aliases: DatabaseName + +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 +``` + +### -ServerName +The name of the server. + +```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. +The value must be an UUID. + +```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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Remove-AzPostgreSqlFlexibleServerFirewallRule.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Remove-AzPostgreSqlFlexibleServerFirewallRule.md new file mode 100644 index 000000000000..b115983ad7a1 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Remove-AzPostgreSqlFlexibleServerFirewallRule.md @@ -0,0 +1,262 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/remove-azpostgresqlflexibleserverfirewallrule +schema: 2.0.0 +--- + +# Remove-AzPostgreSqlFlexibleServerFirewallRule + +## SYNOPSIS +Deletes an existing firewall rule. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPostgreSqlFlexibleServerFirewallRule -Name -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentityFlexibleServer +``` +Remove-AzPostgreSqlFlexibleServerFirewallRule -Name + -FlexibleServerInputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentity +``` +Remove-AzPostgreSqlFlexibleServerFirewallRule -InputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +Deletes an existing firewall rule. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: DeleteViaIdentityFlexibleServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the firewall rule. + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityFlexibleServer +Aliases: FirewallRuleName + +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 +``` + +### -ServerName +The name of the server. + +```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. +The value must be an UUID. + +```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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Remove-AzPostgreSqlFlexibleServerVirtualEndpoint.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Remove-AzPostgreSqlFlexibleServerVirtualEndpoint.md new file mode 100644 index 000000000000..d841b67eac68 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Remove-AzPostgreSqlFlexibleServerVirtualEndpoint.md @@ -0,0 +1,262 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/remove-azpostgresqlflexibleservervirtualendpoint +schema: 2.0.0 +--- + +# Remove-AzPostgreSqlFlexibleServerVirtualEndpoint + +## SYNOPSIS +Deletes a pair of virtual endpoints. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzPostgreSqlFlexibleServerVirtualEndpoint -Name -ResourceGroupName + -ServerName [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentityFlexibleServer +``` +Remove-AzPostgreSqlFlexibleServerVirtualEndpoint -Name + -FlexibleServerInputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-WhatIf] [-Confirm] [] +``` + +### DeleteViaIdentity +``` +Remove-AzPostgreSqlFlexibleServerVirtualEndpoint -InputObject + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +Deletes a pair of virtual endpoints. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: DeleteViaIdentityFlexibleServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Base name of the virtual endpoints. + +```yaml +Type: System.String +Parameter Sets: Delete, DeleteViaIdentityFlexibleServer +Aliases: VirtualEndpointName + +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 +``` + +### -ServerName +The name of the server. + +```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. +The value must be an UUID. + +```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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Restart-AzPostgreSqlFlexibleServer.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Restart-AzPostgreSqlFlexibleServer.md new file mode 100644 index 000000000000..fe4046524fe9 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Restart-AzPostgreSqlFlexibleServer.md @@ -0,0 +1,331 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/restart-azpostgresqlflexibleserver +schema: 2.0.0 +--- + +# Restart-AzPostgreSqlFlexibleServer + +## SYNOPSIS +Restarts PostgreSQL database engine in a server. + +## SYNTAX + +### RestartExpanded (Default) +``` +Restart-AzPostgreSqlFlexibleServer -Name -ResourceGroupName [-SubscriptionId ] + [-FailoverMode ] [-RestartWithFailover] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### RestartViaJsonString +``` +Restart-AzPostgreSqlFlexibleServer -Name -ResourceGroupName [-SubscriptionId ] + -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### RestartViaJsonFilePath +``` +Restart-AzPostgreSqlFlexibleServer -Name -ResourceGroupName [-SubscriptionId ] + -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### Restart +``` +Restart-AzPostgreSqlFlexibleServer -Name -ResourceGroupName [-SubscriptionId ] + -Parameter [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### RestartViaIdentityExpanded +``` +Restart-AzPostgreSqlFlexibleServer -InputObject [-FailoverMode ] + [-RestartWithFailover] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### RestartViaIdentity +``` +Restart-AzPostgreSqlFlexibleServer -InputObject + -Parameter [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Restarts PostgreSQL database engine in a server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -FailoverMode +Failover mode. + +```yaml +Type: System.String +Parameter Sets: RestartExpanded, RestartViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: RestartViaIdentityExpanded, RestartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Restart operation + +```yaml +Type: System.String +Parameter Sets: RestartViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Restart operation + +```yaml +Type: System.String +Parameter Sets: RestartViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: RestartExpanded, RestartViaJsonString, RestartViaJsonFilePath, Restart +Aliases: ServerName + +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 +``` + +### -Parameter +PostgreSQL database engine restart parameters. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IRestartParameter +Parameter Sets: Restart, RestartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +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: RestartExpanded, RestartViaJsonString, RestartViaJsonFilePath, Restart +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RestartWithFailover +Indicates if restart the PostgreSQL database engine should failover or switch over from primary to standby. +This only works if server has high availability enabled. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: RestartExpanded, RestartViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: RestartExpanded, RestartViaJsonString, RestartViaJsonFilePath, Restart +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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IRestartParameter + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Start-AzPostgreSqlFlexibleServer.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Start-AzPostgreSqlFlexibleServer.md new file mode 100644 index 000000000000..d0da38d07d5e --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Start-AzPostgreSqlFlexibleServer.md @@ -0,0 +1,224 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/start-azpostgresqlflexibleserver +schema: 2.0.0 +--- + +# Start-AzPostgreSqlFlexibleServer + +## SYNOPSIS +Starts a stopped server. + +## SYNTAX + +### Start (Default) +``` +Start-AzPostgreSqlFlexibleServer -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + +### StartViaIdentity +``` +Start-AzPostgreSqlFlexibleServer -InputObject [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Starts a stopped server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: StartViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: ServerName + +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: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention.md new file mode 100644 index 000000000000..1a617480fd16 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention.md @@ -0,0 +1,316 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/start-azpostgresqlflexibleserverbackupslongtermretention +schema: 2.0.0 +--- + +# Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention + +## SYNOPSIS +Initiates a long term retention backup. + +## SYNTAX + +### StartViaIdentity (Default) +``` +Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention -InputObject + -Parameter [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### StartViaJsonString +``` +Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention -ResourceGroupName -ServerName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### StartViaJsonFilePath +``` +Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention -ResourceGroupName -ServerName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### StartExpanded +``` +Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention -ResourceGroupName -ServerName + [-SubscriptionId ] -BackupSettingBackupName -TargetDetailSasUriList + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### Start +``` +Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention -ResourceGroupName -ServerName + [-SubscriptionId ] -Parameter [-DefaultProfile ] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### StartViaIdentityExpanded +``` +Start-AzPostgreSqlFlexibleServerBackupsLongTermRetention -InputObject + -BackupSettingBackupName -TargetDetailSasUriList [-DefaultProfile ] + [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Initiates a long term retention backup. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -BackupSettingBackupName +Backup Name for the current backup + +```yaml +Type: System.String +Parameter Sets: StartExpanded, StartViaIdentityExpanded +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 +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: StartViaIdentity, StartViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Start operation + +```yaml +Type: System.String +Parameter Sets: StartViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Start operation + +```yaml +Type: System.String +Parameter Sets: StartViaJsonString +Aliases: + +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 +``` + +### -Parameter +The request that is made for a long term retention backup. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IBackupsLongTermRetentionRequest +Parameter Sets: StartViaIdentity, Start +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: StartViaJsonString, StartViaJsonFilePath, StartExpanded, Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: StartViaJsonString, StartViaJsonFilePath, StartExpanded, Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: StartViaJsonString, StartViaJsonFilePath, StartExpanded, Start +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDetailSasUriList +List of SAS uri of storage containers where backup data is to be streamed/copied. + +```yaml +Type: System.Security.SecureString[] +Parameter Sets: StartExpanded, StartViaIdentityExpanded +Aliases: + +Required: True +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.PostgreSqlFlexibleServer.Models.IBackupsLongTermRetentionRequest + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IBackupsLongTermRetentionResponse + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Stop-AzPostgreSqlFlexibleServer.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Stop-AzPostgreSqlFlexibleServer.md new file mode 100644 index 000000000000..be54a97ce78d --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Stop-AzPostgreSqlFlexibleServer.md @@ -0,0 +1,224 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/stop-azpostgresqlflexibleserver +schema: 2.0.0 +--- + +# Stop-AzPostgreSqlFlexibleServer + +## SYNOPSIS +Stops a server. + +## SYNTAX + +### Stop (Default) +``` +Stop-AzPostgreSqlFlexibleServer -Name -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-WhatIf] + [-Confirm] [] +``` + +### StopViaIdentity +``` +Stop-AzPostgreSqlFlexibleServer -InputObject [-DefaultProfile ] + [-AsJob] [-NoWait] [-PassThru] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Stops a server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: StopViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: ServerName + +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: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Stop-AzPostgreSqlFlexibleServerMigration.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Stop-AzPostgreSqlFlexibleServerMigration.md new file mode 100644 index 000000000000..d8cc42bae5ca --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Stop-AzPostgreSqlFlexibleServerMigration.md @@ -0,0 +1,232 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/stop-azpostgresqlflexibleservermigration +schema: 2.0.0 +--- + +# Stop-AzPostgreSqlFlexibleServerMigration + +## SYNOPSIS +Cancels an active migration. + +## SYNTAX + +### Cancel (Default) +``` +Stop-AzPostgreSqlFlexibleServerMigration -Name -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### CancelViaIdentityFlexibleServer +``` +Stop-AzPostgreSqlFlexibleServerMigration -Name + -FlexibleServerInputObject [-DefaultProfile ] [-PassThru] + [-WhatIf] [-Confirm] [] +``` + +### CancelViaIdentity +``` +Stop-AzPostgreSqlFlexibleServerMigration -InputObject + [-DefaultProfile ] [-PassThru] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Cancels an active migration. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: CancelViaIdentityFlexibleServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: CancelViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of migration. + +```yaml +Type: System.String +Parameter Sets: Cancel, CancelViaIdentityFlexibleServer +Aliases: MigrationName + +Required: True +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: Cancel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: Cancel +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: Cancel +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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IMigration + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite.md new file mode 100644 index 000000000000..65e24a063e65 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite.md @@ -0,0 +1,270 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/test-azpostgresqlflexibleserverbackupslongtermretentionprerequisite +schema: 2.0.0 +--- + +# Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite + +## SYNOPSIS +Performs all checks required for a long term retention backup operation to succeed. + +## SYNTAX + +### CheckExpanded (Default) +``` +Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite -ResourceGroupName + -ServerName [-SubscriptionId ] -BackupSettingBackupName [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### CheckViaJsonString +``` +Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite -ResourceGroupName + -ServerName [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### CheckViaJsonFilePath +``` +Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite -ResourceGroupName + -ServerName [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### Check +``` +Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite -ResourceGroupName + -ServerName [-SubscriptionId ] -Parameter [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### CheckViaIdentityExpanded +``` +Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite + -InputObject -BackupSettingBackupName + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### CheckViaIdentity +``` +Test-AzPostgreSqlFlexibleServerBackupsLongTermRetentionPrerequisite + -InputObject -Parameter + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Performs all checks required for a long term retention backup operation to succeed. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -BackupSettingBackupName +Backup Name for the current backup + +```yaml +Type: System.String +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded +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 +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: CheckViaIdentityExpanded, CheckViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +A request that is made for pre-backup. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.ILtrPreBackupRequest +Parameter Sets: Check, CheckViaIdentity +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: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath, Check +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath, Check +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath, Check +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.PostgreSqlFlexibleServer.Models.ILtrPreBackupRequest + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.ILtrPreBackupResponse + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Test-AzPostgreSqlFlexibleServerMigrationNameAvailability.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Test-AzPostgreSqlFlexibleServerMigrationNameAvailability.md new file mode 100644 index 000000000000..e917c68a6fcf --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Test-AzPostgreSqlFlexibleServerMigrationNameAvailability.md @@ -0,0 +1,285 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/test-azpostgresqlflexibleservermigrationnameavailability +schema: 2.0.0 +--- + +# Test-AzPostgreSqlFlexibleServerMigrationNameAvailability + +## SYNOPSIS +Checks if a proposed migration name is valid and available. + +## SYNTAX + +### CheckExpanded (Default) +``` +Test-AzPostgreSqlFlexibleServerMigrationNameAvailability -ResourceGroupName -ServerName + [-SubscriptionId ] -Name -Type [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### CheckViaJsonString +``` +Test-AzPostgreSqlFlexibleServerMigrationNameAvailability -ResourceGroupName -ServerName + [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### CheckViaJsonFilePath +``` +Test-AzPostgreSqlFlexibleServerMigrationNameAvailability -ResourceGroupName -ServerName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### Check +``` +Test-AzPostgreSqlFlexibleServerMigrationNameAvailability -ResourceGroupName -ServerName + [-SubscriptionId ] -Parameter [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### CheckViaIdentityExpanded +``` +Test-AzPostgreSqlFlexibleServerMigrationNameAvailability -InputObject + -Name -Type [-DefaultProfile ] [-WhatIf] + [-Confirm] [] +``` + +### CheckViaIdentity +``` +Test-AzPostgreSqlFlexibleServerMigrationNameAvailability -InputObject + -Parameter [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Checks if a proposed migration name is valid and available. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: CheckViaIdentityExpanded, CheckViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the migration to check for validity and availability. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Availability of a migration name. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IMigrationNameAvailability +Parameter Sets: Check, CheckViaIdentity +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: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath, Check +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath, Check +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath, Check +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Type of resource. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded +Aliases: + +Required: True +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.PostgreSqlFlexibleServer.Models.IMigrationNameAvailability + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IMigrationNameAvailability + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Test-AzPostgreSqlFlexibleServerNameAvailability.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Test-AzPostgreSqlFlexibleServerNameAvailability.md new file mode 100644 index 000000000000..0cbdc28b1e3d --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Test-AzPostgreSqlFlexibleServerNameAvailability.md @@ -0,0 +1,269 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/test-azpostgresqlflexibleservernameavailability +schema: 2.0.0 +--- + +# Test-AzPostgreSqlFlexibleServerNameAvailability + +## SYNOPSIS +Check the availability of name for resource + +## SYNTAX + +### CheckExpanded (Default) +``` +Test-AzPostgreSqlFlexibleServerNameAvailability -LocationName [-SubscriptionId ] + [-Name ] [-Type ] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] +``` + +### CheckViaJsonString +``` +Test-AzPostgreSqlFlexibleServerNameAvailability -LocationName [-SubscriptionId ] + -JsonString [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### CheckViaJsonFilePath +``` +Test-AzPostgreSqlFlexibleServerNameAvailability -LocationName [-SubscriptionId ] + -JsonFilePath [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### Check +``` +Test-AzPostgreSqlFlexibleServerNameAvailability -LocationName [-SubscriptionId ] + -Parameter [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### CheckViaIdentityExpanded +``` +Test-AzPostgreSqlFlexibleServerNameAvailability -InputObject + [-Name ] [-Type ] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] +``` + +### CheckViaIdentity +``` +Test-AzPostgreSqlFlexibleServerNameAvailability -InputObject + -Parameter [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Check the availability of name for resource + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: CheckViaIdentityExpanded, CheckViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LocationName +The name of the location. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath, Check +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the resource for which availability needs to be checked. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +The check availability request body. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.ICheckNameAvailabilityRequest +Parameter Sets: Check, CheckViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded, CheckViaJsonString, CheckViaJsonFilePath, Check +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The resource type. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded, CheckViaIdentityExpanded +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.PostgreSqlFlexibleServer.Models.ICheckNameAvailabilityRequest + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.INameAvailabilityModel + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Test-AzPostgreSqlFlexibleServerNameAvailabilityGlobally.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Test-AzPostgreSqlFlexibleServerNameAvailabilityGlobally.md new file mode 100644 index 000000000000..e5cd50e562d6 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Test-AzPostgreSqlFlexibleServerNameAvailabilityGlobally.md @@ -0,0 +1,221 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/test-azpostgresqlflexibleservernameavailabilityglobally +schema: 2.0.0 +--- + +# Test-AzPostgreSqlFlexibleServerNameAvailabilityGlobally + +## SYNOPSIS +Checks the validity and availability of the given name, to assign it to a new server or to use it as the base name of a new pair of virtual endpoints. + +## SYNTAX + +### CheckExpanded (Default) +``` +Test-AzPostgreSqlFlexibleServerNameAvailabilityGlobally [-SubscriptionId ] [-Name ] + [-Type ] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### Check +``` +Test-AzPostgreSqlFlexibleServerNameAvailabilityGlobally [-SubscriptionId ] + -Parameter [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### CheckViaJsonFilePath +``` +Test-AzPostgreSqlFlexibleServerNameAvailabilityGlobally [-SubscriptionId ] -JsonFilePath + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### CheckViaJsonString +``` +Test-AzPostgreSqlFlexibleServerNameAvailabilityGlobally [-SubscriptionId ] -JsonString + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Checks the validity and availability of the given name, to assign it to a new server or to use it as the base name of a new pair of virtual endpoints. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -JsonFilePath +Path of Json file supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the resource for which availability needs to be checked. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +The check availability request body. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.ICheckNameAvailabilityRequest +Parameter Sets: Check +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```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 +``` + +### -Type +The resource type. + +```yaml +Type: System.String +Parameter Sets: CheckExpanded +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.PostgreSqlFlexibleServer.Models.ICheckNameAvailabilityRequest + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.INameAvailabilityModel + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Update-AzPostgreSqlFlexibleServer.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Update-AzPostgreSqlFlexibleServer.md new file mode 100644 index 000000000000..45a87e87fadc --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Update-AzPostgreSqlFlexibleServer.md @@ -0,0 +1,838 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/update-azpostgresqlflexibleserver +schema: 2.0.0 +--- + +# Update-AzPostgreSqlFlexibleServer + +## SYNOPSIS +Update a new server. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPostgreSqlFlexibleServer -Name -ResourceGroupName [-SubscriptionId ] + [-AdministratorLoginPassword ] [-AuthConfigActiveDirectoryAuth ] + [-AuthConfigPasswordAuth ] [-AuthConfigTenantId ] [-BackupRetentionDay ] + [-ClusterDefaultDatabaseName ] [-ClusterSize ] [-CreateMode ] + [-DataEncryptionGeoBackupKeyUri ] [-DataEncryptionGeoBackupUserAssignedIdentityId ] + [-DataEncryptionPrimaryKeyUri ] [-DataEncryptionPrimaryUserAssignedIdentityId ] + [-DataEncryptionType ] [-EnableSystemAssignedIdentity ] [-HighAvailabilityMode ] + [-HighAvailabilityStandbyAvailabilityZone ] [-IdentityPrincipalId ] + [-MaintenanceWindowCustomWindow ] [-MaintenanceWindowDayOfWeek ] + [-MaintenanceWindowStartHour ] [-MaintenanceWindowStartMinute ] + [-NetworkDelegatedSubnetResourceId ] [-NetworkPrivateDnsZoneArmResourceId ] + [-NetworkPublicNetworkAccess ] [-ReplicaPromoteMode ] [-ReplicaPromoteOption ] + [-ReplicaRole ] [-ReplicationRole ] [-SkuName ] [-SkuTier ] + [-StorageAutoGrow ] [-StorageIop ] [-StorageSizeGb ] [-StorageThroughput ] + [-StorageTier ] [-StorageType ] [-Tag ] [-UserAssignedIdentity ] + [-Version ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPostgreSqlFlexibleServer -InputObject + [-AdministratorLoginPassword ] [-AuthConfigActiveDirectoryAuth ] + [-AuthConfigPasswordAuth ] [-AuthConfigTenantId ] [-BackupRetentionDay ] + [-ClusterDefaultDatabaseName ] [-ClusterSize ] [-CreateMode ] + [-DataEncryptionGeoBackupKeyUri ] [-DataEncryptionGeoBackupUserAssignedIdentityId ] + [-DataEncryptionPrimaryKeyUri ] [-DataEncryptionPrimaryUserAssignedIdentityId ] + [-DataEncryptionType ] [-EnableSystemAssignedIdentity ] [-HighAvailabilityMode ] + [-HighAvailabilityStandbyAvailabilityZone ] [-IdentityPrincipalId ] + [-MaintenanceWindowCustomWindow ] [-MaintenanceWindowDayOfWeek ] + [-MaintenanceWindowStartHour ] [-MaintenanceWindowStartMinute ] + [-NetworkDelegatedSubnetResourceId ] [-NetworkPrivateDnsZoneArmResourceId ] + [-NetworkPublicNetworkAccess ] [-ReplicaPromoteMode ] [-ReplicaPromoteOption ] + [-ReplicaRole ] [-ReplicationRole ] [-SkuName ] [-SkuTier ] + [-StorageAutoGrow ] [-StorageIop ] [-StorageSizeGb ] [-StorageThroughput ] + [-StorageTier ] [-StorageType ] [-Tag ] [-UserAssignedIdentity ] + [-Version ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Update a new server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AdministratorLoginPassword +Password assigned to the administrator login. +As long as password authentication is enabled, this password can be changed at any time. + +```yaml +Type: System.Security.SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -AuthConfigActiveDirectoryAuth +Indicates if the server supports Microsoft Entra authentication. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthConfigPasswordAuth +Indicates if the server supports password based authentication. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AuthConfigTenantId +Identifier of the tenant of the delegated resource. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupRetentionDay +Backup retention days for the server. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterDefaultDatabaseName +Default database name for the elastic cluster. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClusterSize +Number of nodes assigned to the elastic cluster. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreateMode +Creation mode of a new server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataEncryptionGeoBackupKeyUri +Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a server that is configured to support geographically redundant backups. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataEncryptionGeoBackupUserAssignedIdentityId +Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a server that is configured to support geographically redundant backups. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataEncryptionPrimaryKeyUri +URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataEncryptionPrimaryUserAssignedIdentityId +Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the primary storage associated to a server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataEncryptionType +Data encryption type used by a server. + +```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 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 +``` + +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. + +```yaml +Type: System.Nullable`1[System.Boolean] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighAvailabilityMode +High availability mode for a server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HighAvailabilityStandbyAvailabilityZone +Availability zone associated to the standby server created when high availability is set to SameZone or ZoneRedundant. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityPrincipalId +Identifier of the object of the service principal associated to the user assigned managed identity. + +```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 + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MaintenanceWindowCustomWindow +Indicates whether custom window is enabled or disabled. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaintenanceWindowDayOfWeek +Day of the week to be used for maintenance window. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaintenanceWindowStartHour +Start hour to be used for maintenance window. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MaintenanceWindowStartMinute +Start minute to be used for maintenance window. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the server. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: ServerName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkDelegatedSubnetResourceId +Resource identifier of the delegated subnet. +Required during creation of a new server, in case you want the server to be integrated into your own virtual network. +For an update operation, you only have to provide this property if you want to change the value assigned for the private DNS zone. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkPrivateDnsZoneArmResourceId +Identifier of the private DNS zone. +Required during creation of a new server, in case you want the server to be integrated into your own virtual network. +For an update operation, you only have to provide this property if you want to change the value assigned for the private DNS zone. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkPublicNetworkAccess +Indicates if public network access is enabled or not. +This is only supported for servers that are not integrated into a virtual network which is owned and provided by customer when server is deployed. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +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 +``` + +### -ReplicaPromoteMode +Type of operation to apply on the read replica. +This property is write only. +Standalone means that the read replica will be promoted to a standalone server, and will become a completely independent entity from the replication set. +Switchover means that the read replica will roles with the primary server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicaPromoteOption +Data synchronization option to use when processing the operation specified in the promoteMode property. +This property is write only. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicaRole +Role of the server in a replication set. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationRole +Role of the server in a replication set. + +```yaml +Type: System.String +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: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +Name by which is known a given compute size assigned to a server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +Tier of the compute assigned to a server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageAutoGrow +Flag to enable or disable the automatic growth of storage size of a server when available space is nearing zero and conditions allow for automatically growing storage size. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageIop +Maximum IOPS supported for storage. +Required when type of storage is PremiumV2_LRS or UltraSSD_LRS. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageSizeGb +Size of storage assigned to a server. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageThroughput +Maximum throughput supported for storage. +Required when type of storage is PremiumV2_LRS or UltraSSD_LRS. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageTier +Storage tier of a server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageType +Type of storage assigned to a server. +Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. +If not specified, it defaults to Premium_LRS. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```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 +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The array of user assigned identities associated with the resource. +The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.' + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Major version of PostgreSQL database engine. + +```yaml +Type: System.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: 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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IServer + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Update-AzPostgreSqlFlexibleServerConfiguration.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Update-AzPostgreSqlFlexibleServerConfiguration.md new file mode 100644 index 000000000000..0aacd2b4f447 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Update-AzPostgreSqlFlexibleServerConfiguration.md @@ -0,0 +1,324 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/update-azpostgresqlflexibleserverconfiguration +schema: 2.0.0 +--- + +# Update-AzPostgreSqlFlexibleServerConfiguration + +## SYNOPSIS +Update the value assigned to a specific modifiable configuration (also known as server parameter) of a server. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPostgreSqlFlexibleServerConfiguration -Name -ResourceGroupName -ServerName + [-SubscriptionId ] [-Source ] [-Value ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaJsonString +``` +Update-AzPostgreSqlFlexibleServerConfiguration -Name -ResourceGroupName -ServerName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzPostgreSqlFlexibleServerConfiguration -Name -ResourceGroupName -ServerName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityFlexibleServerExpanded +``` +Update-AzPostgreSqlFlexibleServerConfiguration -Name + -FlexibleServerInputObject [-Source ] [-Value ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPostgreSqlFlexibleServerConfiguration -InputObject + [-Source ] [-Value ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Update the value assigned to a specific modifiable configuration (also known as server parameter) of a server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: UpdateViaIdentityFlexibleServerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of the configuration (also known as server parameter). + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath, UpdateViaIdentityFlexibleServerExpanded +Aliases: ConfigurationName + +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 +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Source +Source of the value assigned to the configuration (also known as server parameter). +Required to update the value assigned to a specific modifiable configuration. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityFlexibleServerExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Value +Value of the configuration (also known as server parameter). +Required to update the value assigned to a specific modifiable configuration. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityFlexibleServerExpanded, 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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IConfiguration + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Update-AzPostgreSqlFlexibleServerDatabase.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Update-AzPostgreSqlFlexibleServerDatabase.md new file mode 100644 index 000000000000..b8681222390b --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Update-AzPostgreSqlFlexibleServerDatabase.md @@ -0,0 +1,279 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/update-azpostgresqlflexibleserverdatabase +schema: 2.0.0 +--- + +# Update-AzPostgreSqlFlexibleServerDatabase + +## SYNOPSIS +Update a new database. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPostgreSqlFlexibleServerDatabase -Name -ResourceGroupName -ServerName + [-SubscriptionId ] [-Charset ] [-Collation ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityFlexibleServerExpanded +``` +Update-AzPostgreSqlFlexibleServerDatabase -Name + -FlexibleServerInputObject [-Charset ] [-Collation ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPostgreSqlFlexibleServerDatabase -InputObject [-Charset ] + [-Collation ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Update a new database. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -Charset +Character set of the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Collation +Collation of the database. + +```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 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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: UpdateViaIdentityFlexibleServerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the database (case-sensitive). +Exact database names can be retrieved by getting the list of all existing databases in a server. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityFlexibleServerExpanded +Aliases: DatabaseName + +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 +``` + +### -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 +``` + +### -ServerName +The name of the server. + +```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. +The value must be an UUID. + +```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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IDatabase + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Update-AzPostgreSqlFlexibleServerFirewallRule.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Update-AzPostgreSqlFlexibleServerFirewallRule.md new file mode 100644 index 000000000000..9f100d8a35af --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Update-AzPostgreSqlFlexibleServerFirewallRule.md @@ -0,0 +1,280 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/update-azpostgresqlflexibleserverfirewallrule +schema: 2.0.0 +--- + +# Update-AzPostgreSqlFlexibleServerFirewallRule + +## SYNOPSIS +Update a new firewall rule or update an existing firewall rule. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPostgreSqlFlexibleServerFirewallRule -Name -ResourceGroupName -ServerName + [-SubscriptionId ] [-EndIPAddress ] [-StartIPAddress ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityFlexibleServerExpanded +``` +Update-AzPostgreSqlFlexibleServerFirewallRule -Name + -FlexibleServerInputObject [-EndIPAddress ] + [-StartIPAddress ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPostgreSqlFlexibleServerFirewallRule -InputObject + [-EndIPAddress ] [-StartIPAddress ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Update a new firewall rule or update an existing firewall rule. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -EndIPAddress +IP address defining the end of the range of addresses of a firewall rule. +Must be expressed in IPv4 format. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: UpdateViaIdentityFlexibleServerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Name of the firewall rule. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityFlexibleServerExpanded +Aliases: FirewallRuleName + +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 +``` + +### -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 +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartIPAddress +IP address defining the start of the range of addresses of a firewall rule. +Must be expressed in IPv4 format. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IFirewallRule + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Update-AzPostgreSqlFlexibleServerMigration.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Update-AzPostgreSqlFlexibleServerMigration.md new file mode 100644 index 000000000000..11829fb0aba6 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Update-AzPostgreSqlFlexibleServerMigration.md @@ -0,0 +1,580 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/update-azpostgresqlflexibleservermigration +schema: 2.0.0 +--- + +# Update-AzPostgreSqlFlexibleServerMigration + +## SYNOPSIS +Update an existing migration. +The request body can contain one to many of the mutable properties present in the migration definition. +Certain property update initiate migration state transitions. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPostgreSqlFlexibleServerMigration -Name -ResourceGroupName -ServerName + [-SubscriptionId ] [-AdminCredentialsSourceServerPassword ] + [-AdminCredentialsTargetServerPassword ] [-Cancel ] [-DbsToCancelMigrationOn ] + [-DbsToMigrate ] [-DbsToTriggerCutoverOn ] [-MigrateRole ] + [-MigrationMode ] [-MigrationWindowStartTimeInUtc ] [-OverwriteDbsInTarget ] + [-SecretParameterSourceServerUsername ] [-SecretParameterTargetServerUsername ] + [-SetupLogicalReplicationOnSourceDbIfNeeded ] [-SourceDbServerFullyQualifiedDomainName ] + [-SourceDbServerResourceId ] [-StartDataMigration ] [-Tag ] + [-TargetDbServerFullyQualifiedDomainName ] [-TriggerCutover ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaJsonString +``` +Update-AzPostgreSqlFlexibleServerMigration -Name -ResourceGroupName -ServerName + [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzPostgreSqlFlexibleServerMigration -Name -ResourceGroupName -ServerName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityFlexibleServerExpanded +``` +Update-AzPostgreSqlFlexibleServerMigration -Name + -FlexibleServerInputObject + [-AdminCredentialsSourceServerPassword ] [-AdminCredentialsTargetServerPassword ] + [-Cancel ] [-DbsToCancelMigrationOn ] [-DbsToMigrate ] + [-DbsToTriggerCutoverOn ] [-MigrateRole ] [-MigrationMode ] + [-MigrationWindowStartTimeInUtc ] [-OverwriteDbsInTarget ] + [-SecretParameterSourceServerUsername ] [-SecretParameterTargetServerUsername ] + [-SetupLogicalReplicationOnSourceDbIfNeeded ] [-SourceDbServerFullyQualifiedDomainName ] + [-SourceDbServerResourceId ] [-StartDataMigration ] [-Tag ] + [-TargetDbServerFullyQualifiedDomainName ] [-TriggerCutover ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPostgreSqlFlexibleServerMigration -InputObject + [-AdminCredentialsSourceServerPassword ] [-AdminCredentialsTargetServerPassword ] + [-Cancel ] [-DbsToCancelMigrationOn ] [-DbsToMigrate ] + [-DbsToTriggerCutoverOn ] [-MigrateRole ] [-MigrationMode ] + [-MigrationWindowStartTimeInUtc ] [-OverwriteDbsInTarget ] + [-SecretParameterSourceServerUsername ] [-SecretParameterTargetServerUsername ] + [-SetupLogicalReplicationOnSourceDbIfNeeded ] [-SourceDbServerFullyQualifiedDomainName ] + [-SourceDbServerResourceId ] [-StartDataMigration ] [-Tag ] + [-TargetDbServerFullyQualifiedDomainName ] [-TriggerCutover ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Update an existing migration. +The request body can contain one to many of the mutable properties present in the migration definition. +Certain property update initiate migration state transitions. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AdminCredentialsSourceServerPassword +Password for the user of the source server. + +```yaml +Type: System.Security.SecureString +Parameter Sets: UpdateExpanded, UpdateViaIdentityFlexibleServerExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdminCredentialsTargetServerPassword +Password for the user of the target server. + +```yaml +Type: System.Security.SecureString +Parameter Sets: UpdateExpanded, UpdateViaIdentityFlexibleServerExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Cancel +Indicates if cancel must be triggered for the entire migration. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityFlexibleServerExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DbsToCancelMigrationOn +When you want to trigger cancel for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array. + +```yaml +Type: System.String[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityFlexibleServerExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DbsToMigrate +Names of databases to migrate. + +```yaml +Type: System.String[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityFlexibleServerExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DbsToTriggerCutoverOn +When you want to trigger cutover for specific databases set 'triggerCutover' to 'True' and the names of the specific databases in this array. + +```yaml +Type: System.String[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityFlexibleServerExpanded, 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 +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: UpdateViaIdentityFlexibleServerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrateRole +Indicates if roles and permissions must be migrated. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityFlexibleServerExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationMode +Mode used to perform the migration: Online or Offline. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityFlexibleServerExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MigrationWindowStartTimeInUtc +Start time (UTC) for migration window. + +```yaml +Type: System.DateTime +Parameter Sets: UpdateExpanded, UpdateViaIdentityFlexibleServerExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Name of migration. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath, UpdateViaIdentityFlexibleServerExpanded +Aliases: MigrationName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OverwriteDbsInTarget +Indicates if databases on the target server can be overwritten when already present. +If set to 'False', when the migration workflow detects that the database already exists on the target server, it will wait for a confirmation. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityFlexibleServerExpanded, UpdateViaIdentityExpanded +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: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretParameterSourceServerUsername +Gets or sets the name of the user for the source server. +This user doesn't need to be an administrator. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityFlexibleServerExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SecretParameterTargetServerUsername +Gets or sets the name of the user for the target server. +This user doesn't need to be an administrator. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityFlexibleServerExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SetupLogicalReplicationOnSourceDbIfNeeded +Indicates whether to setup logical replication on source server, if needed. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityFlexibleServerExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceDbServerFullyQualifiedDomainName +Fully qualified domain name (FQDN) or IP address of the source server. +This property is optional. +When provided, the migration service will always use it to connect to the source server. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityFlexibleServerExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceDbServerResourceId +Identifier of the source database server resource, when 'sourceType' is 'PostgreSQLSingleServer'. +For other source types this must be set to ipaddress:port@username or hostname:port@username. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityFlexibleServerExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StartDataMigration +Indicates if data migration must start right away. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityFlexibleServerExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Application-specific metadata in the form of key-value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded, UpdateViaIdentityFlexibleServerExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDbServerFullyQualifiedDomainName +Fully qualified domain name (FQDN) or IP address of the target server. +This property is optional. +When provided, the migration service will always use it to connect to the target server. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityFlexibleServerExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TriggerCutover +Indicates if cutover must be triggered for the entire migration. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityFlexibleServerExpanded, 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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IMigration + +## NOTES + +## RELATED LINKS diff --git a/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Update-AzPostgreSqlFlexibleServerVirtualEndpoint.md b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Update-AzPostgreSqlFlexibleServerVirtualEndpoint.md new file mode 100644 index 000000000000..01449760a464 --- /dev/null +++ b/src/PostgreSQLFlexibleServer/PostgreSqlFlexibleServer/help/Update-AzPostgreSqlFlexibleServerVirtualEndpoint.md @@ -0,0 +1,323 @@ +--- +external help file: Az.PostgreSqlFlexibleServer-help.xml +Module Name: Az.PostgreSqlFlexibleServer +online version: https://learn.microsoft.com/powershell/module/az.postgresqlflexibleserver/update-azpostgresqlflexibleservervirtualendpoint +schema: 2.0.0 +--- + +# Update-AzPostgreSqlFlexibleServerVirtualEndpoint + +## SYNOPSIS +Update a pair of virtual endpoints for a server. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzPostgreSqlFlexibleServerVirtualEndpoint -Name -ResourceGroupName + -ServerName [-SubscriptionId ] [-EndpointType ] [-Member ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### UpdateViaJsonString +``` +Update-AzPostgreSqlFlexibleServerVirtualEndpoint -Name -ResourceGroupName + -ServerName [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzPostgreSqlFlexibleServerVirtualEndpoint -Name -ResourceGroupName + -ServerName [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] + [-NoWait] [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityFlexibleServerExpanded +``` +Update-AzPostgreSqlFlexibleServerVirtualEndpoint -Name + -FlexibleServerInputObject [-EndpointType ] [-Member ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzPostgreSqlFlexibleServerVirtualEndpoint -InputObject + [-EndpointType ] [-Member ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Update a pair of virtual endpoints for a server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## 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 +``` + +### -EndpointType +Type of endpoint for the virtual endpoints. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityFlexibleServerExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FlexibleServerInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: UpdateViaIdentityFlexibleServerExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Member +List of servers that one of the virtual endpoints can refer to. + +```yaml +Type: System.String[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityFlexibleServerExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +Base name of the virtual endpoints. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath, UpdateViaIdentityFlexibleServerExpanded +Aliases: VirtualEndpointName + +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 +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServerName +The name of the server. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath +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.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IVirtualEndpoint + +## NOTES + +## RELATED LINKS diff --git a/tools/CreateMappings_rules.json b/tools/CreateMappings_rules.json index a0606c2b87f1..820d0cc0a315 100644 --- a/tools/CreateMappings_rules.json +++ b/tools/CreateMappings_rules.json @@ -1007,5 +1007,9 @@ { "alias": "EdgeAction", "module": "EdgeAction" + }, + { + "module": "PostgreSqlFlexibleServer", + "alias": "PostgreSqlFlexibleServer" } ]