diff --git a/src/MySql/docs/Az.MySql.md b/src/MySql/docs/Az.MySql.md index 07dda35b8bd1..1e1f59bac940 100644 --- a/src/MySql/docs/Az.MySql.md +++ b/src/MySql/docs/Az.MySql.md @@ -1,6 +1,6 @@ --- Module Name: Az.MySql -Module Guid: 71b613fa-1c6a-420e-976b-91de82d27c68 +Module Guid: 0c9ad3d3-5d2e-4727-8628-71ff53cf49a2 Download Help Link: https://docs.microsoft.com/en-us/powershell/module/az.mysql Help Version: 1.0.0.0 Locale: en-US @@ -20,6 +20,36 @@ Get the connection string according to client connection provider. ### [Get-AzMySqlFirewallRule](Get-AzMySqlFirewallRule.md) Gets information about a server firewall rule. +### [Get-AzMySqlFlexibleServer](Get-AzMySqlFlexibleServer.md) +Gets information about a server. + +### [Get-AzMySqlFlexibleServerConfiguration](Get-AzMySqlFlexibleServerConfiguration.md) +List all the configurations in a given server. + +### [Get-AzMySqlFlexibleServerDatabase](Get-AzMySqlFlexibleServerDatabase.md) +List all the databases in a given server. + +### [Get-AzMySqlFlexibleServerFirewallRule](Get-AzMySqlFlexibleServerFirewallRule.md) +List all the firewall rules in a given server. + +### [Get-AzMySqlFlexibleServerKey](Get-AzMySqlFlexibleServerKey.md) +Gets a server key. + +### [Get-AzMySqlFlexibleServerReplica](Get-AzMySqlFlexibleServerReplica.md) +List all the replicas for a given server. + +### [Get-AzMySqlFlexibleServersConfiguration](Get-AzMySqlFlexibleServersConfiguration.md) +Gets information about a configuration of server. + +### [Get-AzMySqlFlexibleServersDatabase](Get-AzMySqlFlexibleServersDatabase.md) +Gets information about a database. + +### [Get-AzMySqlFlexibleServersFirewallRule](Get-AzMySqlFlexibleServersFirewallRule.md) +Gets information about a server firewall rule. + +### [Get-AzMySqlLocationBasedCapability](Get-AzMySqlLocationBasedCapability.md) +Get capabilities at specified location in a given subscription. + ### [Get-AzMySqlReplica](Get-AzMySqlReplica.md) List all the replicas for a given server. @@ -29,9 +59,25 @@ Gets information about a server. ### [Get-AzMySqlVirtualNetworkRule](Get-AzMySqlVirtualNetworkRule.md) Gets a virtual network rule. +### [Get-AzMySqlVirtualNetworkSubnetUsage](Get-AzMySqlVirtualNetworkSubnetUsage.md) +Get virtual network subnet usage for a given vNet resource id. + ### [New-AzMySqlFirewallRule](New-AzMySqlFirewallRule.md) Creates a new firewall rule or updates an existing firewall rule. +### [New-AzMySqlFlexibleServer](New-AzMySqlFlexibleServer.md) +Creates a new server or updates an existing server. +The update action will overwrite the existing server. + +### [New-AzMySqlFlexibleServerDatabase](New-AzMySqlFlexibleServerDatabase.md) +Creates a new database or updates an existing database. + +### [New-AzMySqlFlexibleServerFirewallRule](New-AzMySqlFlexibleServerFirewallRule.md) +Creates a new firewall rule or updates an existing firewall rule. + +### [New-AzMySqlFlexibleServerKey](New-AzMySqlFlexibleServerKey.md) +Creates or updates a MySQL Server key. + ### [New-AzMySqlReplica](New-AzMySqlReplica.md) Creates a new replica from an existing database. @@ -44,18 +90,54 @@ Creates or updates an existing virtual network rule. ### [Remove-AzMySqlFirewallRule](Remove-AzMySqlFirewallRule.md) Deletes a server firewall rule. +### [Remove-AzMySqlFlexibleServer](Remove-AzMySqlFlexibleServer.md) +Deletes a server. + +### [Remove-AzMySqlFlexibleServerKey](Remove-AzMySqlFlexibleServerKey.md) +Deletes the MySQL Server key with the given name. + +### [Remove-AzMySqlFlexibleServersDatabase](Remove-AzMySqlFlexibleServersDatabase.md) +Deletes a database. + +### [Remove-AzMySqlFlexibleServersFirewallRule](Remove-AzMySqlFlexibleServersFirewallRule.md) +Deletes a firewall rule. + ### [Remove-AzMySqlServer](Remove-AzMySqlServer.md) Deletes a server. ### [Remove-AzMySqlVirtualNetworkRule](Remove-AzMySqlVirtualNetworkRule.md) Deletes the virtual network rule with the given name. +### [Restart-AzMySqlFlexibleServer](Restart-AzMySqlFlexibleServer.md) +Restarts a server. + ### [Restart-AzMySqlServer](Restart-AzMySqlServer.md) Restarts a server. ### [Restore-AzMySqlServer](Restore-AzMySqlServer.md) Restore a server from an existing backup +### [Set-AzMySqlFlexibleServerDatabase](Set-AzMySqlFlexibleServerDatabase.md) +Creates a new database or updates an existing database. + +### [Set-AzMySqlFlexibleServerFirewallRule](Set-AzMySqlFlexibleServerFirewallRule.md) +Creates a new firewall rule or updates an existing firewall rule. + +### [Set-AzMySqlFlexibleServerKey](Set-AzMySqlFlexibleServerKey.md) +Creates or updates a MySQL Server key. + +### [Start-AzMySqlFlexibleServer](Start-AzMySqlFlexibleServer.md) +Starts a server. + +### [Stop-AzMySqlFlexibleServer](Stop-AzMySqlFlexibleServer.md) +Stops a server. + +### [Test-AzMySqlFlexibleServersNameAvailability](Test-AzMySqlFlexibleServersNameAvailability.md) +Check the availability of name for server + +### [Test-AzMySqlNameAvailability](Test-AzMySqlNameAvailability.md) +Check the availability of name for resource + ### [Update-AzMySqlConfiguration](Update-AzMySqlConfiguration.md) Updates a configuration of a server. Use Update-AzMySqlServer instead if you want update AdministratorLoginPassword, sku, etc. @@ -63,6 +145,13 @@ Use Update-AzMySqlServer instead if you want update AdministratorLoginPassword, ### [Update-AzMySqlFirewallRule](Update-AzMySqlFirewallRule.md) Creates a new firewall rule or updates an existing firewall rule. +### [Update-AzMySqlFlexibleServer](Update-AzMySqlFlexibleServer.md) +Updates an existing server. +The request body can contain one to many of the properties present in the normal server definition. + +### [Update-AzMySqlFlexibleServersConfiguration](Update-AzMySqlFlexibleServersConfiguration.md) +Updates a configuration of a server. + ### [Update-AzMySqlServer](Update-AzMySqlServer.md) Updates an existing server. The request body can contain one to many of the properties present in the normal server definition. diff --git a/src/MySql/docs/Get-AzMySqlConfiguration.md b/src/MySql/docs/Get-AzMySqlConfiguration.md index 50efb1f5315f..e38c2f7c6429 100644 --- a/src/MySql/docs/Get-AzMySqlConfiguration.md +++ b/src/MySql/docs/Get-AzMySqlConfiguration.md @@ -183,6 +183,7 @@ INPUTOBJECT : Identity Parameter - `[DatabaseName ]`: The name of the database. - `[FirewallRuleName ]`: The name of the server firewall rule. - `[Id ]`: Resource identity path + - `[KeyName ]`: The name of the server key. - `[LocationName ]`: The name of the location. - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - `[SecurityAlertPolicyName ]`: The name of the security alert policy. diff --git a/src/MySql/docs/Get-AzMySqlFirewallRule.md b/src/MySql/docs/Get-AzMySqlFirewallRule.md index 02a7cf376106..9fa728f0c250 100644 --- a/src/MySql/docs/Get-AzMySqlFirewallRule.md +++ b/src/MySql/docs/Get-AzMySqlFirewallRule.md @@ -187,6 +187,7 @@ INPUTOBJECT : Identity Parameter - `[DatabaseName ]`: The name of the database. - `[FirewallRuleName ]`: The name of the server firewall rule. - `[Id ]`: Resource identity path + - `[KeyName ]`: The name of the server key. - `[LocationName ]`: The name of the location. - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - `[SecurityAlertPolicyName ]`: The name of the security alert policy. diff --git a/src/MySql/docs/Get-AzMySqlFlexibleServer.md b/src/MySql/docs/Get-AzMySqlFlexibleServer.md new file mode 100644 index 000000000000..b2e4fc7c4c4a --- /dev/null +++ b/src/MySql/docs/Get-AzMySqlFlexibleServer.md @@ -0,0 +1,173 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://docs.microsoft.com/en-us/powershell/module/az.mysql/get-azmysqlflexibleserver +schema: 2.0.0 +--- + +# Get-AzMySqlFlexibleServer + +## SYNOPSIS +Gets information about a server. + +## SYNTAX + +### List1 (Default) +``` +Get-AzMySqlFlexibleServer [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzMySqlFlexibleServer -ResourceGroupName -ServerName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzMySqlFlexibleServer -InputObject [-DefaultProfile ] [] +``` + +### List +``` +Get-AzMySqlFlexibleServer -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets information about a server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +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 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, List, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20200701Privatepreview.IServerAutoGenerated + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[ConfigurationName ]`: The name of the server configuration. + - `[DatabaseName ]`: The name of the database. + - `[FirewallRuleName ]`: The name of the server firewall rule. + - `[Id ]`: Resource identity path + - `[KeyName ]`: The name of the server key. + - `[LocationName ]`: The name of the location. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName ]`: The name of the security alert policy. + - `[ServerName ]`: The name of the server. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[VirtualNetworkRuleName ]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/src/MySql/docs/Get-AzMySqlFlexibleServerConfiguration.md b/src/MySql/docs/Get-AzMySqlFlexibleServerConfiguration.md new file mode 100644 index 000000000000..83c4e78823b3 --- /dev/null +++ b/src/MySql/docs/Get-AzMySqlFlexibleServerConfiguration.md @@ -0,0 +1,120 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://docs.microsoft.com/en-us/powershell/module/az.mysql/get-azmysqlflexibleserverconfiguration +schema: 2.0.0 +--- + +# Get-AzMySqlFlexibleServerConfiguration + +## SYNOPSIS +List all the configurations in a given server. + +## SYNTAX + +``` +Get-AzMySqlFlexibleServerConfiguration -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +List all the configurations in a given server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```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.MySql.Models.Api20200701Privatepreview.IConfigurationAutoGenerated + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/src/MySql/docs/Get-AzMySqlFlexibleServerDatabase.md b/src/MySql/docs/Get-AzMySqlFlexibleServerDatabase.md new file mode 100644 index 000000000000..d5d919d1c7b3 --- /dev/null +++ b/src/MySql/docs/Get-AzMySqlFlexibleServerDatabase.md @@ -0,0 +1,120 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://docs.microsoft.com/en-us/powershell/module/az.mysql/get-azmysqlflexibleserverdatabase +schema: 2.0.0 +--- + +# Get-AzMySqlFlexibleServerDatabase + +## SYNOPSIS +List all the databases in a given server. + +## SYNTAX + +``` +Get-AzMySqlFlexibleServerDatabase -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +List all the databases in a given server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```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.MySql.Models.Api20171201.IDatabase + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/src/MySql/docs/Get-AzMySqlFlexibleServerFirewallRule.md b/src/MySql/docs/Get-AzMySqlFlexibleServerFirewallRule.md new file mode 100644 index 000000000000..efe2333d51fa --- /dev/null +++ b/src/MySql/docs/Get-AzMySqlFlexibleServerFirewallRule.md @@ -0,0 +1,120 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://docs.microsoft.com/en-us/powershell/module/az.mysql/get-azmysqlflexibleserverfirewallrule +schema: 2.0.0 +--- + +# Get-AzMySqlFlexibleServerFirewallRule + +## SYNOPSIS +List all the firewall rules in a given server. + +## SYNTAX + +``` +Get-AzMySqlFlexibleServerFirewallRule -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +## DESCRIPTION +List all the firewall rules in a given server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```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.MySql.Models.Api20171201.IFirewallRule + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/src/MySql/docs/Get-AzMySqlFlexibleServerKey.md b/src/MySql/docs/Get-AzMySqlFlexibleServerKey.md new file mode 100644 index 000000000000..19b269bdcb17 --- /dev/null +++ b/src/MySql/docs/Get-AzMySqlFlexibleServerKey.md @@ -0,0 +1,183 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://docs.microsoft.com/en-us/powershell/module/az.mysql/get-azmysqlflexibleserverkey +schema: 2.0.0 +--- + +# Get-AzMySqlFlexibleServerKey + +## SYNOPSIS +Gets a server key. + +## SYNTAX + +### List (Default) +``` +Get-AzMySqlFlexibleServerKey -ResourceGroupName -ServerName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### Get +``` +Get-AzMySqlFlexibleServerKey -KeyName -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzMySqlFlexibleServerKey -InputObject [-DefaultProfile ] [] +``` + +## DESCRIPTION +Gets a server key. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyName +The name of the server key. + +```yaml +Type: System.String +Parameter Sets: 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: 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. + +```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.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20200701Privatepreview.IServerKey + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[ConfigurationName ]`: The name of the server configuration. + - `[DatabaseName ]`: The name of the database. + - `[FirewallRuleName ]`: The name of the server firewall rule. + - `[Id ]`: Resource identity path + - `[KeyName ]`: The name of the server key. + - `[LocationName ]`: The name of the location. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName ]`: The name of the security alert policy. + - `[ServerName ]`: The name of the server. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[VirtualNetworkRuleName ]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/src/MySql/docs/Get-AzMySqlFlexibleServerReplica.md b/src/MySql/docs/Get-AzMySqlFlexibleServerReplica.md new file mode 100644 index 000000000000..8c42479113bf --- /dev/null +++ b/src/MySql/docs/Get-AzMySqlFlexibleServerReplica.md @@ -0,0 +1,120 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://docs.microsoft.com/en-us/powershell/module/az.mysql/get-azmysqlflexibleserverreplica +schema: 2.0.0 +--- + +# Get-AzMySqlFlexibleServerReplica + +## SYNOPSIS +List all the replicas for a given server. + +## SYNTAX + +``` +Get-AzMySqlFlexibleServerReplica -ResourceGroupName -ServerName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +List all the replicas for a given server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```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.MySql.Models.Api20200701Privatepreview.IServerAutoGenerated + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/src/MySql/docs/Get-AzMySqlFlexibleServersConfiguration.md b/src/MySql/docs/Get-AzMySqlFlexibleServersConfiguration.md new file mode 100644 index 000000000000..c43a9244e67a --- /dev/null +++ b/src/MySql/docs/Get-AzMySqlFlexibleServersConfiguration.md @@ -0,0 +1,178 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://docs.microsoft.com/en-us/powershell/module/az.mysql/get-azmysqlflexibleserversconfiguration +schema: 2.0.0 +--- + +# Get-AzMySqlFlexibleServersConfiguration + +## SYNOPSIS +Gets information about a configuration of server. + +## SYNTAX + +### Get (Default) +``` +Get-AzMySqlFlexibleServersConfiguration -ConfigurationName -ResourceGroupName + -ServerName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzMySqlFlexibleServersConfiguration -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Gets information about a configuration of server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -ConfigurationName +The name of the server configuration. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +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 +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 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get +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.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20200701Privatepreview.IConfigurationAutoGenerated + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[ConfigurationName ]`: The name of the server configuration. + - `[DatabaseName ]`: The name of the database. + - `[FirewallRuleName ]`: The name of the server firewall rule. + - `[Id ]`: Resource identity path + - `[KeyName ]`: The name of the server key. + - `[LocationName ]`: The name of the location. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName ]`: The name of the security alert policy. + - `[ServerName ]`: The name of the server. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[VirtualNetworkRuleName ]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/src/MySql/docs/Get-AzMySqlFlexibleServersDatabase.md b/src/MySql/docs/Get-AzMySqlFlexibleServersDatabase.md new file mode 100644 index 000000000000..0a39a62254f7 --- /dev/null +++ b/src/MySql/docs/Get-AzMySqlFlexibleServersDatabase.md @@ -0,0 +1,178 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://docs.microsoft.com/en-us/powershell/module/az.mysql/get-azmysqlflexibleserversdatabase +schema: 2.0.0 +--- + +# Get-AzMySqlFlexibleServersDatabase + +## SYNOPSIS +Gets information about a database. + +## SYNTAX + +### Get (Default) +``` +Get-AzMySqlFlexibleServersDatabase -DatabaseName -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzMySqlFlexibleServersDatabase -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Gets information about a database. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DatabaseName +The name of the database. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +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 +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 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get +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.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IDatabase + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[ConfigurationName ]`: The name of the server configuration. + - `[DatabaseName ]`: The name of the database. + - `[FirewallRuleName ]`: The name of the server firewall rule. + - `[Id ]`: Resource identity path + - `[KeyName ]`: The name of the server key. + - `[LocationName ]`: The name of the location. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName ]`: The name of the security alert policy. + - `[ServerName ]`: The name of the server. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[VirtualNetworkRuleName ]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/src/MySql/docs/Get-AzMySqlFlexibleServersFirewallRule.md b/src/MySql/docs/Get-AzMySqlFlexibleServersFirewallRule.md new file mode 100644 index 000000000000..0935d4c8186a --- /dev/null +++ b/src/MySql/docs/Get-AzMySqlFlexibleServersFirewallRule.md @@ -0,0 +1,178 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://docs.microsoft.com/en-us/powershell/module/az.mysql/get-azmysqlflexibleserversfirewallrule +schema: 2.0.0 +--- + +# Get-AzMySqlFlexibleServersFirewallRule + +## SYNOPSIS +Gets information about a server firewall rule. + +## SYNTAX + +### Get (Default) +``` +Get-AzMySqlFlexibleServersFirewallRule -FirewallRuleName -ResourceGroupName + -ServerName [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzMySqlFlexibleServersFirewallRule -InputObject [-DefaultProfile ] + [] +``` + +## DESCRIPTION +Gets information about a server firewall rule. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallRuleName +The name of the server firewall rule. + +```yaml +Type: System.String +Parameter Sets: Get +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +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 +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 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get +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.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IFirewallRule + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[ConfigurationName ]`: The name of the server configuration. + - `[DatabaseName ]`: The name of the database. + - `[FirewallRuleName ]`: The name of the server firewall rule. + - `[Id ]`: Resource identity path + - `[KeyName ]`: The name of the server key. + - `[LocationName ]`: The name of the location. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName ]`: The name of the security alert policy. + - `[ServerName ]`: The name of the server. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[VirtualNetworkRuleName ]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/src/MySql/docs/Get-AzMySqlLocationBasedCapability.md b/src/MySql/docs/Get-AzMySqlLocationBasedCapability.md new file mode 100644 index 000000000000..7ab7618cbd4b --- /dev/null +++ b/src/MySql/docs/Get-AzMySqlLocationBasedCapability.md @@ -0,0 +1,104 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://docs.microsoft.com/en-us/powershell/module/az.mysql/get-azmysqllocationbasedcapability +schema: 2.0.0 +--- + +# Get-AzMySqlLocationBasedCapability + +## SYNOPSIS +Get capabilities at specified location in a given subscription. + +## SYNTAX + +``` +Get-AzMySqlLocationBasedCapability -LocationName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +## DESCRIPTION +Get capabilities at specified location in a given subscription. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```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.MySql.Models.Api20200701Privatepreview.ICapabilityProperties + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/src/MySql/docs/Get-AzMySqlServer.md b/src/MySql/docs/Get-AzMySqlServer.md index 2858d27dc39f..0aecfacce834 100644 --- a/src/MySql/docs/Get-AzMySqlServer.md +++ b/src/MySql/docs/Get-AzMySqlServer.md @@ -188,6 +188,7 @@ INPUTOBJECT : Identity Parameter - `[DatabaseName ]`: The name of the database. - `[FirewallRuleName ]`: The name of the server firewall rule. - `[Id ]`: Resource identity path + - `[KeyName ]`: The name of the server key. - `[LocationName ]`: The name of the location. - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - `[SecurityAlertPolicyName ]`: The name of the security alert policy. diff --git a/src/MySql/docs/Get-AzMySqlVirtualNetworkRule.md b/src/MySql/docs/Get-AzMySqlVirtualNetworkRule.md index 1ec1563c6c33..133da7f19ef7 100644 --- a/src/MySql/docs/Get-AzMySqlVirtualNetworkRule.md +++ b/src/MySql/docs/Get-AzMySqlVirtualNetworkRule.md @@ -203,6 +203,7 @@ INPUTOBJECT : Identity Parameter - `[DatabaseName ]`: The name of the database. - `[FirewallRuleName ]`: The name of the server firewall rule. - `[Id ]`: Resource identity path + - `[KeyName ]`: The name of the server key. - `[LocationName ]`: The name of the location. - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - `[SecurityAlertPolicyName ]`: The name of the security alert policy. diff --git a/src/MySql/docs/Get-AzMySqlVirtualNetworkSubnetUsage.md b/src/MySql/docs/Get-AzMySqlVirtualNetworkSubnetUsage.md new file mode 100644 index 000000000000..8b757b309ce2 --- /dev/null +++ b/src/MySql/docs/Get-AzMySqlVirtualNetworkSubnetUsage.md @@ -0,0 +1,228 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://docs.microsoft.com/en-us/powershell/module/az.mysql/get-azmysqlvirtualnetworksubnetusage +schema: 2.0.0 +--- + +# Get-AzMySqlVirtualNetworkSubnetUsage + +## SYNOPSIS +Get virtual network subnet usage for a given vNet resource id. + +## SYNTAX + +### GetExpanded (Default) +``` +Get-AzMySqlVirtualNetworkSubnetUsage -LocationName [-SubscriptionId ] + [-VirtualNetworkArmResourceId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### Get +``` +Get-AzMySqlVirtualNetworkSubnetUsage -LocationName -Parameter + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### GetViaIdentity +``` +Get-AzMySqlVirtualNetworkSubnetUsage -InputObject + -Parameter [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### GetViaIdentityExpanded +``` +Get-AzMySqlVirtualNetworkSubnetUsage -InputObject [-VirtualNetworkArmResourceId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Get virtual network subnet usage for a given vNet resource id. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: GetViaIdentity, GetViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -LocationName +The name of the location. + +```yaml +Type: System.String +Parameter Sets: Get, GetExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +Virtual network subnet usage parameter +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20200701Privatepreview.IVirtualNetworkSubnetUsageParameter +Parameter Sets: Get, GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String[] +Parameter Sets: Get, GetExpanded +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: GetExpanded, GetViaIdentityExpanded +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.MySql.Models.Api20200701Privatepreview.IVirtualNetworkSubnetUsageParameter + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20200701Privatepreview.IDelegatedSubnetUsage + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[ConfigurationName ]`: The name of the server configuration. + - `[DatabaseName ]`: The name of the database. + - `[FirewallRuleName ]`: The name of the server firewall rule. + - `[Id ]`: Resource identity path + - `[KeyName ]`: The name of the server key. + - `[LocationName ]`: The name of the location. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName ]`: The name of the security alert policy. + - `[ServerName ]`: The name of the server. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[VirtualNetworkRuleName ]`: The name of the virtual network rule. + +PARAMETER : Virtual network subnet usage parameter + - `[VirtualNetworkArmResourceId ]`: Virtual network resource id. + +## RELATED LINKS + diff --git a/src/MySql/docs/New-AzMySqlFlexibleServer.md b/src/MySql/docs/New-AzMySqlFlexibleServer.md new file mode 100644 index 000000000000..0b146f133445 --- /dev/null +++ b/src/MySql/docs/New-AzMySqlFlexibleServer.md @@ -0,0 +1,634 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://docs.microsoft.com/en-us/powershell/module/az.mysql/new-azmysqlflexibleserver +schema: 2.0.0 +--- + +# New-AzMySqlFlexibleServer + +## SYNOPSIS +Creates a new server or updates an existing server. +The update action will overwrite the existing server. + +## SYNTAX + +``` +New-AzMySqlFlexibleServer -ResourceGroupName -ServerName -Location + [-SubscriptionId ] [-AdministratorLogin ] [-AdministratorLoginPassword ] + [-AvailabilityZone ] [-CreateMode ] + [-DelegatedSubnetArgumentSubnetArmResourceId ] [-EarliestRestoreDate ] + [-HaEnabled ] [-IdentityType ] + [-InfrastructureEncryption ] [-MaintenanceWindowCustomWindow ] + [-MaintenanceWindowDayOfWeek ] [-MaintenanceWindowStartHour ] + [-MaintenanceWindowStartMinute ] [-PropertiesTag ] + [-PublicNetworkAccess ] [-ReplicaCapacity ] [-ReplicationRole ] + [-RestorePointInTime ] [-SkuName ] [-SkuTier ] [-SourceServerId ] + [-SslEnforcement ] [-StorageProfileBackupRetentionDay ] + [-StorageProfileStorageAutogrow ] [-StorageProfileStorageIop ] + [-StorageProfileStorageMb ] [-Tag ] [-Version ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates a new server or updates an existing server. +The update action will overwrite the existing server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AdministratorLogin +The administrator's login name of a server. +Can only be specified when the server is being created (and is required for creation). + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AdministratorLoginPassword +The password of the administrator login (required for server creation). + +```yaml +Type: System.String +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 +``` + +### -AvailabilityZone +availability Zone information of the server. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CreateMode +The mode to create a new MySQL server. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Support.CreateMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DelegatedSubnetArgumentSubnetArmResourceId +delegated subnet arm resource id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EarliestRestoreDate +Earliest restore point creation time (ISO8601 format) + +```yaml +Type: System.DateTime +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HaEnabled +Enable HA or not for a server. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Support.HaEnabledEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +The identity type. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Support.ResourceIdentityType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InfrastructureEncryption +Status showing whether the server enabled infrastructure encryption. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Support.InfrastructureEncryptionEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +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 week 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 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 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 +``` + +### -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 +``` + +### -PropertiesTag +Application-specific metadata in the form of key-value pairs. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublicNetworkAccess +Whether or not public network access is allowed for this server. +Value is optional but if passed in, must be 'Enabled' or 'Disabled' + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Support.PublicNetworkAccessEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicaCapacity +The maximum number of replicas that a primary server can have. + +```yaml +Type: System.Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationRole +The replication role. + +```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 +``` + +### -RestorePointInTime +Restore point creation time (ISO8601 format), specifying the time to restore from. + +```yaml +Type: System.DateTime +Parameter Sets: (All) +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: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuName +The name of the sku, e.g. +Standard_D32s_v3. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +The tier of the particular SKU, e.g. +GeneralPurpose. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Support.SkuTier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceServerId +The source MySQL server id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslEnforcement +Enable ssl enforcement or not when connect to server. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Support.SslEnforcementEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageProfileBackupRetentionDay +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 +``` + +### -StorageProfileStorageAutogrow +Enable Storage Auto Grow. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Support.StorageAutogrow +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageProfileStorageIop +Storage IOPS for 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 +``` + +### -StorageProfileStorageMb +Max storage allowed for 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 +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Version +Server version. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Support.ServerVersion +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 + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20200701Privatepreview.IServerAutoGenerated + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/src/MySql/docs/New-AzMySqlFlexibleServerDatabase.md b/src/MySql/docs/New-AzMySqlFlexibleServerDatabase.md new file mode 100644 index 000000000000..a91327b0760f --- /dev/null +++ b/src/MySql/docs/New-AzMySqlFlexibleServerDatabase.md @@ -0,0 +1,227 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://docs.microsoft.com/en-us/powershell/module/az.mysql/new-azmysqlflexibleserverdatabase +schema: 2.0.0 +--- + +# New-AzMySqlFlexibleServerDatabase + +## SYNOPSIS +Creates a new database or updates an existing database. + +## SYNTAX + +``` +New-AzMySqlFlexibleServerDatabase -DatabaseName -ResourceGroupName -ServerName + [-SubscriptionId ] [-Charset ] [-Collation ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates a new database or updates an existing database. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ 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 +The charset 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 +The 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 +``` + +### -DatabaseName +The name of the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IDatabase + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/src/MySql/docs/New-AzMySqlFlexibleServerFirewallRule.md b/src/MySql/docs/New-AzMySqlFlexibleServerFirewallRule.md new file mode 100644 index 000000000000..043ca762ed87 --- /dev/null +++ b/src/MySql/docs/New-AzMySqlFlexibleServerFirewallRule.md @@ -0,0 +1,229 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://docs.microsoft.com/en-us/powershell/module/az.mysql/new-azmysqlflexibleserverfirewallrule +schema: 2.0.0 +--- + +# New-AzMySqlFlexibleServerFirewallRule + +## SYNOPSIS +Creates a new firewall rule or updates an existing firewall rule. + +## SYNTAX + +``` +New-AzMySqlFlexibleServerFirewallRule -FirewallRuleName -ResourceGroupName + -ServerName -EndIPAddress -StartIPAddress [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates a new firewall rule or updates an existing firewall rule. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ 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 credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndIPAddress +The end IP address of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallRuleName +The name of the server firewall rule. + +```yaml +Type: System.String +Parameter Sets: (All) +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 +``` + +### -StartIPAddress +The start IP address of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IFirewallRule + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/src/MySql/docs/New-AzMySqlFlexibleServerKey.md b/src/MySql/docs/New-AzMySqlFlexibleServerKey.md new file mode 100644 index 000000000000..271c484f7798 --- /dev/null +++ b/src/MySql/docs/New-AzMySqlFlexibleServerKey.md @@ -0,0 +1,212 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://docs.microsoft.com/en-us/powershell/module/az.mysql/new-azmysqlflexibleserverkey +schema: 2.0.0 +--- + +# New-AzMySqlFlexibleServerKey + +## SYNOPSIS +Creates or updates a MySQL Server key. + +## SYNTAX + +``` +New-AzMySqlFlexibleServerKey -KeyName -ResourceGroupName -ServerName + [-SubscriptionId ] [-Uri ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Creates or updates a MySQL Server key. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ 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 credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyName +The name of the server key. + +```yaml +Type: System.String +Parameter Sets: (All) +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 +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Uri +The URI of the key. + +```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 + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20200701Privatepreview.IServerKey + +## NOTES + +ALIASES + +## RELATED LINKS + diff --git a/src/MySql/docs/New-AzMySqlVirtualNetworkRule.md b/src/MySql/docs/New-AzMySqlVirtualNetworkRule.md index 047983425161..a3bec6784dc1 100644 --- a/src/MySql/docs/New-AzMySqlVirtualNetworkRule.md +++ b/src/MySql/docs/New-AzMySqlVirtualNetworkRule.md @@ -23,17 +23,23 @@ Creates or updates an existing virtual network rule. ## EXAMPLES -### Example 1: Create a new MySql server Virtual Network Rule +### Example 1: {{ Add title here }} ```powershell -PS C:\> $ID = "/subscriptions//resourceGroups/PowershellMySqlTest/providers/Microsoft.Network/virtualNetworks/MySqlVNet/subnets/MysqlSubnet1" -PS C:\> New-AzMySqlVirtualNetworkRule -Name vnet -ResourceGroupName PowershellMySqlTest -ServerName mysql-test -SubnetId $ID +PS C:\> {{ Add code here }} -Name Type ----- ---- -vnet Microsoft.DBforMySQL/servers/virtualNetworkRules +{{ Add output here }} ``` -These cmdlets create a MySql server Virtual Network Rule. +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} ## PARAMETERS diff --git a/src/MySql/docs/Remove-AzMySqlFirewallRule.md b/src/MySql/docs/Remove-AzMySqlFirewallRule.md index 8b0940bf0560..2a9b617e855e 100644 --- a/src/MySql/docs/Remove-AzMySqlFirewallRule.md +++ b/src/MySql/docs/Remove-AzMySqlFirewallRule.md @@ -242,6 +242,7 @@ INPUTOBJECT : Identity Parameter - `[DatabaseName ]`: The name of the database. - `[FirewallRuleName ]`: The name of the server firewall rule. - `[Id ]`: Resource identity path + - `[KeyName ]`: The name of the server key. - `[LocationName ]`: The name of the location. - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - `[SecurityAlertPolicyName ]`: The name of the security alert policy. diff --git a/src/MySql/docs/Remove-AzMySqlFlexibleServer.md b/src/MySql/docs/Remove-AzMySqlFlexibleServer.md new file mode 100644 index 000000000000..760b9601cbda --- /dev/null +++ b/src/MySql/docs/Remove-AzMySqlFlexibleServer.md @@ -0,0 +1,239 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://docs.microsoft.com/en-us/powershell/module/az.mysql/remove-azmysqlflexibleserver +schema: 2.0.0 +--- + +# Remove-AzMySqlFlexibleServer + +## SYNOPSIS +Deletes a server. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMySqlFlexibleServer -ResourceGroupName -ServerName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzMySqlFlexibleServer -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes a server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ 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 credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +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. + +```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.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[ConfigurationName ]`: The name of the server configuration. + - `[DatabaseName ]`: The name of the database. + - `[FirewallRuleName ]`: The name of the server firewall rule. + - `[Id ]`: Resource identity path + - `[KeyName ]`: The name of the server key. + - `[LocationName ]`: The name of the location. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName ]`: The name of the security alert policy. + - `[ServerName ]`: The name of the server. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[VirtualNetworkRuleName ]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/src/MySql/docs/Remove-AzMySqlFlexibleServerKey.md b/src/MySql/docs/Remove-AzMySqlFlexibleServerKey.md new file mode 100644 index 000000000000..1d9c42c47d2a --- /dev/null +++ b/src/MySql/docs/Remove-AzMySqlFlexibleServerKey.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://docs.microsoft.com/en-us/powershell/module/az.mysql/remove-azmysqlflexibleserverkey +schema: 2.0.0 +--- + +# Remove-AzMySqlFlexibleServerKey + +## SYNOPSIS +Deletes the MySQL Server key with the given name. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMySqlFlexibleServerKey -KeyName -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-AzMySqlFlexibleServerKey -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes the MySQL Server key with the given name. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ 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 credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: DeleteViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeyName +The name of the server key. + +```yaml +Type: System.String +Parameter Sets: Delete +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 +``` + +### -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. + +```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.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[ConfigurationName ]`: The name of the server configuration. + - `[DatabaseName ]`: The name of the database. + - `[FirewallRuleName ]`: The name of the server firewall rule. + - `[Id ]`: Resource identity path + - `[KeyName ]`: The name of the server key. + - `[LocationName ]`: The name of the location. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName ]`: The name of the security alert policy. + - `[ServerName ]`: The name of the server. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[VirtualNetworkRuleName ]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/src/MySql/docs/Remove-AzMySqlFlexibleServersDatabase.md b/src/MySql/docs/Remove-AzMySqlFlexibleServersDatabase.md new file mode 100644 index 000000000000..623bc3b73771 --- /dev/null +++ b/src/MySql/docs/Remove-AzMySqlFlexibleServersDatabase.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://docs.microsoft.com/en-us/powershell/module/az.mysql/remove-azmysqlflexibleserversdatabase +schema: 2.0.0 +--- + +# Remove-AzMySqlFlexibleServersDatabase + +## SYNOPSIS +Deletes a database. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMySqlFlexibleServersDatabase -DatabaseName -ResourceGroupName -ServerName + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] + [] +``` + +### DeleteViaIdentity +``` +Remove-AzMySqlFlexibleServersDatabase -InputObject [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes a database. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ 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 +``` + +### -DatabaseName +The name of the database. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +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. + +```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.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[ConfigurationName ]`: The name of the server configuration. + - `[DatabaseName ]`: The name of the database. + - `[FirewallRuleName ]`: The name of the server firewall rule. + - `[Id ]`: Resource identity path + - `[KeyName ]`: The name of the server key. + - `[LocationName ]`: The name of the location. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName ]`: The name of the security alert policy. + - `[ServerName ]`: The name of the server. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[VirtualNetworkRuleName ]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/src/MySql/docs/Remove-AzMySqlFlexibleServersFirewallRule.md b/src/MySql/docs/Remove-AzMySqlFlexibleServersFirewallRule.md new file mode 100644 index 000000000000..827792da0c11 --- /dev/null +++ b/src/MySql/docs/Remove-AzMySqlFlexibleServersFirewallRule.md @@ -0,0 +1,255 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://docs.microsoft.com/en-us/powershell/module/az.mysql/remove-azmysqlflexibleserversfirewallrule +schema: 2.0.0 +--- + +# Remove-AzMySqlFlexibleServersFirewallRule + +## SYNOPSIS +Deletes a firewall rule. + +## SYNTAX + +### Delete (Default) +``` +Remove-AzMySqlFlexibleServersFirewallRule -FirewallRuleName -ResourceGroupName + -ServerName [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] + [-Confirm] [-WhatIf] [] +``` + +### DeleteViaIdentity +``` +Remove-AzMySqlFlexibleServersFirewallRule -InputObject [-DefaultProfile ] [-AsJob] + [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Deletes a firewall rule. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ 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 credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallRuleName +The name of the server firewall rule. + +```yaml +Type: System.String +Parameter Sets: Delete +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +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. + +```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.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[ConfigurationName ]`: The name of the server configuration. + - `[DatabaseName ]`: The name of the database. + - `[FirewallRuleName ]`: The name of the server firewall rule. + - `[Id ]`: Resource identity path + - `[KeyName ]`: The name of the server key. + - `[LocationName ]`: The name of the location. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName ]`: The name of the security alert policy. + - `[ServerName ]`: The name of the server. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[VirtualNetworkRuleName ]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/src/MySql/docs/Remove-AzMySqlServer.md b/src/MySql/docs/Remove-AzMySqlServer.md index fbf7d517afa1..37b1679472d0 100644 --- a/src/MySql/docs/Remove-AzMySqlServer.md +++ b/src/MySql/docs/Remove-AzMySqlServer.md @@ -226,6 +226,7 @@ INPUTOBJECT : Identity Parameter - `[DatabaseName ]`: The name of the database. - `[FirewallRuleName ]`: The name of the server firewall rule. - `[Id ]`: Resource identity path + - `[KeyName ]`: The name of the server key. - `[LocationName ]`: The name of the location. - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - `[SecurityAlertPolicyName ]`: The name of the security alert policy. diff --git a/src/MySql/docs/Remove-AzMySqlVirtualNetworkRule.md b/src/MySql/docs/Remove-AzMySqlVirtualNetworkRule.md index 91b5ec97f8b8..0dfe8e08b23d 100644 --- a/src/MySql/docs/Remove-AzMySqlVirtualNetworkRule.md +++ b/src/MySql/docs/Remove-AzMySqlVirtualNetworkRule.md @@ -242,6 +242,7 @@ INPUTOBJECT : Identity Parameter - `[DatabaseName ]`: The name of the database. - `[FirewallRuleName ]`: The name of the server firewall rule. - `[Id ]`: Resource identity path + - `[KeyName ]`: The name of the server key. - `[LocationName ]`: The name of the location. - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - `[SecurityAlertPolicyName ]`: The name of the security alert policy. diff --git a/src/MySql/docs/Restart-AzMySqlFlexibleServer.md b/src/MySql/docs/Restart-AzMySqlFlexibleServer.md new file mode 100644 index 000000000000..5f3fa08ed63e --- /dev/null +++ b/src/MySql/docs/Restart-AzMySqlFlexibleServer.md @@ -0,0 +1,239 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://docs.microsoft.com/en-us/powershell/module/az.mysql/restart-azmysqlflexibleserver +schema: 2.0.0 +--- + +# Restart-AzMySqlFlexibleServer + +## SYNOPSIS +Restarts a server. + +## SYNTAX + +### Restart (Default) +``` +Restart-AzMySqlFlexibleServer -ResourceGroupName -ServerName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### RestartViaIdentity +``` +Restart-AzMySqlFlexibleServer -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Restarts a server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ 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 credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: RestartViaIdentity +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: Restart +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: Restart +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: 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.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[ConfigurationName ]`: The name of the server configuration. + - `[DatabaseName ]`: The name of the database. + - `[FirewallRuleName ]`: The name of the server firewall rule. + - `[Id ]`: Resource identity path + - `[KeyName ]`: The name of the server key. + - `[LocationName ]`: The name of the location. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName ]`: The name of the security alert policy. + - `[ServerName ]`: The name of the server. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[VirtualNetworkRuleName ]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/src/MySql/docs/Restart-AzMySqlServer.md b/src/MySql/docs/Restart-AzMySqlServer.md index f194edec1de0..b5f309d4a9bc 100644 --- a/src/MySql/docs/Restart-AzMySqlServer.md +++ b/src/MySql/docs/Restart-AzMySqlServer.md @@ -226,6 +226,7 @@ INPUTOBJECT : Identity Parameter - `[DatabaseName ]`: The name of the database. - `[FirewallRuleName ]`: The name of the server firewall rule. - `[Id ]`: Resource identity path + - `[KeyName ]`: The name of the server key. - `[LocationName ]`: The name of the location. - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - `[SecurityAlertPolicyName ]`: The name of the security alert policy. diff --git a/src/MySql/docs/Set-AzMySqlFlexibleServerDatabase.md b/src/MySql/docs/Set-AzMySqlFlexibleServerDatabase.md new file mode 100644 index 000000000000..331ed33f2c5d --- /dev/null +++ b/src/MySql/docs/Set-AzMySqlFlexibleServerDatabase.md @@ -0,0 +1,262 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://docs.microsoft.com/en-us/powershell/module/az.mysql/set-azmysqlflexibleserverdatabase +schema: 2.0.0 +--- + +# Set-AzMySqlFlexibleServerDatabase + +## SYNOPSIS +Creates a new database or updates an existing database. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Set-AzMySqlFlexibleServerDatabase -DatabaseName -ResourceGroupName -ServerName + [-SubscriptionId ] [-Charset ] [-Collation ] [-DefaultProfile ] [-AsJob] + [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### Update +``` +Set-AzMySqlFlexibleServerDatabase -DatabaseName -ResourceGroupName -ServerName + -Parameter [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Creates a new database or updates an existing database. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ 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 +The charset of the database. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Collation +The collation of the database. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DatabaseName +The name of the database. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +Represents a Database. +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IDatabase +Parameter Sets: Update +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IDatabase + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IDatabase + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +PARAMETER : Represents a Database. + - `[Charset ]`: The charset of the database. + - `[Collation ]`: The collation of the database. + +## RELATED LINKS + diff --git a/src/MySql/docs/Set-AzMySqlFlexibleServerFirewallRule.md b/src/MySql/docs/Set-AzMySqlFlexibleServerFirewallRule.md new file mode 100644 index 000000000000..5c7ccd211646 --- /dev/null +++ b/src/MySql/docs/Set-AzMySqlFlexibleServerFirewallRule.md @@ -0,0 +1,264 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://docs.microsoft.com/en-us/powershell/module/az.mysql/set-azmysqlflexibleserverfirewallrule +schema: 2.0.0 +--- + +# Set-AzMySqlFlexibleServerFirewallRule + +## SYNOPSIS +Creates a new firewall rule or updates an existing firewall rule. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Set-AzMySqlFlexibleServerFirewallRule -FirewallRuleName -ResourceGroupName + -ServerName -EndIPAddress -StartIPAddress [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### Update +``` +Set-AzMySqlFlexibleServerFirewallRule -FirewallRuleName -ResourceGroupName + -ServerName -Parameter [-SubscriptionId ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Creates a new firewall rule or updates an existing firewall rule. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ 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 credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndIPAddress +The end IP address of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirewallRuleName +The name of the server firewall rule. + +```yaml +Type: System.String +Parameter Sets: (All) +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 +Represents a server firewall rule. +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IFirewallRule +Parameter Sets: Update +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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 +``` + +### -StartIPAddress +The start IP address of the server firewall rule. +Must be IPv4 format. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IFirewallRule + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.IFirewallRule + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +PARAMETER : Represents a server firewall rule. + - `EndIPAddress `: The end IP address of the server firewall rule. Must be IPv4 format. + - `StartIPAddress `: The start IP address of the server firewall rule. Must be IPv4 format. + +## RELATED LINKS + diff --git a/src/MySql/docs/Set-AzMySqlFlexibleServerKey.md b/src/MySql/docs/Set-AzMySqlFlexibleServerKey.md new file mode 100644 index 000000000000..2cdbbe214c56 --- /dev/null +++ b/src/MySql/docs/Set-AzMySqlFlexibleServerKey.md @@ -0,0 +1,246 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://docs.microsoft.com/en-us/powershell/module/az.mysql/set-azmysqlflexibleserverkey +schema: 2.0.0 +--- + +# Set-AzMySqlFlexibleServerKey + +## SYNOPSIS +Creates or updates a MySQL Server key. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Set-AzMySqlFlexibleServerKey -KeyName -ResourceGroupName -ServerName + [-SubscriptionId ] [-Uri ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### Update +``` +Set-AzMySqlFlexibleServerKey -KeyName -ResourceGroupName -ServerName + -Parameter [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Creates or updates a MySQL Server key. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ 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 credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -KeyName +The name of the server key. + +```yaml +Type: System.String +Parameter Sets: (All) +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 +A MySQL Server key. +To construct, see NOTES section for PARAMETER properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20200701Privatepreview.IServerKey +Parameter Sets: Update +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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. + +```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 +``` + +### -Uri +The URI of the key. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: 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.MySql.Models.Api20200701Privatepreview.IServerKey + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20200701Privatepreview.IServerKey + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +PARAMETER : A MySQL Server key. + - `[Uri ]`: The URI of the key. + +## RELATED LINKS + diff --git a/src/MySql/docs/Start-AzMySqlFlexibleServer.md b/src/MySql/docs/Start-AzMySqlFlexibleServer.md new file mode 100644 index 000000000000..16582b9f5700 --- /dev/null +++ b/src/MySql/docs/Start-AzMySqlFlexibleServer.md @@ -0,0 +1,239 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://docs.microsoft.com/en-us/powershell/module/az.mysql/start-azmysqlflexibleserver +schema: 2.0.0 +--- + +# Start-AzMySqlFlexibleServer + +## SYNOPSIS +Starts a server. + +## SYNTAX + +### Start (Default) +``` +Start-AzMySqlFlexibleServer -ResourceGroupName -ServerName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### StartViaIdentity +``` +Start-AzMySqlFlexibleServer -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Starts a server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ 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 credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: StartViaIdentity +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: 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: Start +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Start +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[ConfigurationName ]`: The name of the server configuration. + - `[DatabaseName ]`: The name of the database. + - `[FirewallRuleName ]`: The name of the server firewall rule. + - `[Id ]`: Resource identity path + - `[KeyName ]`: The name of the server key. + - `[LocationName ]`: The name of the location. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName ]`: The name of the security alert policy. + - `[ServerName ]`: The name of the server. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[VirtualNetworkRuleName ]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/src/MySql/docs/Stop-AzMySqlFlexibleServer.md b/src/MySql/docs/Stop-AzMySqlFlexibleServer.md new file mode 100644 index 000000000000..d2619e1967bc --- /dev/null +++ b/src/MySql/docs/Stop-AzMySqlFlexibleServer.md @@ -0,0 +1,239 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://docs.microsoft.com/en-us/powershell/module/az.mysql/stop-azmysqlflexibleserver +schema: 2.0.0 +--- + +# Stop-AzMySqlFlexibleServer + +## SYNOPSIS +Stops a server. + +## SYNTAX + +### Stop (Default) +``` +Stop-AzMySqlFlexibleServer -ResourceGroupName -ServerName [-SubscriptionId ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-PassThru] [-Confirm] [-WhatIf] [] +``` + +### StopViaIdentity +``` +Stop-AzMySqlFlexibleServer -InputObject [-DefaultProfile ] [-AsJob] [-NoWait] + [-PassThru] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Stops a server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ 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 credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: StopViaIdentity +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: Stop +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: Stop +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Stop +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### System.Boolean + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[ConfigurationName ]`: The name of the server configuration. + - `[DatabaseName ]`: The name of the database. + - `[FirewallRuleName ]`: The name of the server firewall rule. + - `[Id ]`: Resource identity path + - `[KeyName ]`: The name of the server key. + - `[LocationName ]`: The name of the location. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName ]`: The name of the security alert policy. + - `[ServerName ]`: The name of the server. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[VirtualNetworkRuleName ]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/src/MySql/docs/Test-AzMySqlFlexibleServersNameAvailability.md b/src/MySql/docs/Test-AzMySqlFlexibleServersNameAvailability.md new file mode 100644 index 000000000000..3762a9d402db --- /dev/null +++ b/src/MySql/docs/Test-AzMySqlFlexibleServersNameAvailability.md @@ -0,0 +1,228 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://docs.microsoft.com/en-us/powershell/module/az.mysql/test-azmysqlflexibleserversnameavailability +schema: 2.0.0 +--- + +# Test-AzMySqlFlexibleServersNameAvailability + +## SYNOPSIS +Check the availability of name for server + +## SYNTAX + +### TestExpanded (Default) +``` +Test-AzMySqlFlexibleServersNameAvailability -Name [-SubscriptionId ] [-Type ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### Test +``` +Test-AzMySqlFlexibleServersNameAvailability -NameAvailabilityRequest + [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### TestViaIdentity +``` +Test-AzMySqlFlexibleServersNameAvailability -InputObject + -NameAvailabilityRequest [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### TestViaIdentityExpanded +``` +Test-AzMySqlFlexibleServersNameAvailability -InputObject -Name [-Type ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Check the availability of name for server + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: TestViaIdentity, TestViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource name to verify. + +```yaml +Type: System.String +Parameter Sets: TestExpanded, TestViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NameAvailabilityRequest +Request from client to check resource name availability. +To construct, see NOTES section for NAMEAVAILABILITYREQUEST properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.INameAvailabilityRequest +Parameter Sets: Test, TestViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Test, TestExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Resource type used for verification. + +```yaml +Type: System.String +Parameter Sets: TestExpanded, TestViaIdentityExpanded +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.MySql.Models.Api20171201.INameAvailabilityRequest + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.INameAvailability + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[ConfigurationName ]`: The name of the server configuration. + - `[DatabaseName ]`: The name of the database. + - `[FirewallRuleName ]`: The name of the server firewall rule. + - `[Id ]`: Resource identity path + - `[KeyName ]`: The name of the server key. + - `[LocationName ]`: The name of the location. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName ]`: The name of the security alert policy. + - `[ServerName ]`: The name of the server. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[VirtualNetworkRuleName ]`: The name of the virtual network rule. + +NAMEAVAILABILITYREQUEST : Request from client to check resource name availability. + - `Name `: Resource name to verify. + - `[Type ]`: Resource type used for verification. + +## RELATED LINKS + diff --git a/src/MySql/docs/Test-AzMySqlNameAvailability.md b/src/MySql/docs/Test-AzMySqlNameAvailability.md new file mode 100644 index 000000000000..8070ede088c7 --- /dev/null +++ b/src/MySql/docs/Test-AzMySqlNameAvailability.md @@ -0,0 +1,227 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://docs.microsoft.com/en-us/powershell/module/az.mysql/test-azmysqlnameavailability +schema: 2.0.0 +--- + +# Test-AzMySqlNameAvailability + +## SYNOPSIS +Check the availability of name for resource + +## SYNTAX + +### TestExpanded (Default) +``` +Test-AzMySqlNameAvailability -Name [-SubscriptionId ] [-Type ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### Test +``` +Test-AzMySqlNameAvailability -NameAvailabilityRequest [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### TestViaIdentity +``` +Test-AzMySqlNameAvailability -InputObject -NameAvailabilityRequest + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### TestViaIdentityExpanded +``` +Test-AzMySqlNameAvailability -InputObject -Name [-Type ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Check the availability of name for resource + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: TestViaIdentity, TestViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Name +Resource name to verify. + +```yaml +Type: System.String +Parameter Sets: TestExpanded, TestViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NameAvailabilityRequest +Request from client to check resource name availability. +To construct, see NOTES section for NAMEAVAILABILITYREQUEST properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.INameAvailabilityRequest +Parameter Sets: Test, TestViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Test, TestExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Resource type used for verification. + +```yaml +Type: System.String +Parameter Sets: TestExpanded, TestViaIdentityExpanded +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.MySql.Models.Api20171201.INameAvailabilityRequest + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20171201.INameAvailability + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[ConfigurationName ]`: The name of the server configuration. + - `[DatabaseName ]`: The name of the database. + - `[FirewallRuleName ]`: The name of the server firewall rule. + - `[Id ]`: Resource identity path + - `[KeyName ]`: The name of the server key. + - `[LocationName ]`: The name of the location. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName ]`: The name of the security alert policy. + - `[ServerName ]`: The name of the server. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[VirtualNetworkRuleName ]`: The name of the virtual network rule. + +NAMEAVAILABILITYREQUEST : Request from client to check resource name availability. + - `Name `: Resource name to verify. + - `[Type ]`: Resource type used for verification. + +## RELATED LINKS + diff --git a/src/MySql/docs/Update-AzMySqlConfiguration.md b/src/MySql/docs/Update-AzMySqlConfiguration.md index 3a5d7fd00c2b..7203046c366a 100644 --- a/src/MySql/docs/Update-AzMySqlConfiguration.md +++ b/src/MySql/docs/Update-AzMySqlConfiguration.md @@ -265,6 +265,7 @@ INPUTOBJECT : Identity Parameter. - `[DatabaseName ]`: The name of the database. - `[FirewallRuleName ]`: The name of the server firewall rule. - `[Id ]`: Resource identity path + - `[KeyName ]`: The name of the server key. - `[LocationName ]`: The name of the location. - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - `[SecurityAlertPolicyName ]`: The name of the security alert policy. diff --git a/src/MySql/docs/Update-AzMySqlFirewallRule.md b/src/MySql/docs/Update-AzMySqlFirewallRule.md index 2e3b54ae6b30..d26c38c6f3a5 100644 --- a/src/MySql/docs/Update-AzMySqlFirewallRule.md +++ b/src/MySql/docs/Update-AzMySqlFirewallRule.md @@ -306,6 +306,7 @@ INPUTOBJECT : Identity Parameter - `[DatabaseName ]`: The name of the database. - `[FirewallRuleName ]`: The name of the server firewall rule. - `[Id ]`: Resource identity path + - `[KeyName ]`: The name of the server key. - `[LocationName ]`: The name of the location. - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - `[SecurityAlertPolicyName ]`: The name of the security alert policy. diff --git a/src/MySql/docs/Update-AzMySqlFlexibleServer.md b/src/MySql/docs/Update-AzMySqlFlexibleServer.md new file mode 100644 index 000000000000..a56901ffcfd1 --- /dev/null +++ b/src/MySql/docs/Update-AzMySqlFlexibleServer.md @@ -0,0 +1,498 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://docs.microsoft.com/en-us/powershell/module/az.mysql/update-azmysqlflexibleserver +schema: 2.0.0 +--- + +# Update-AzMySqlFlexibleServer + +## SYNOPSIS +Updates an existing server. +The request body can contain one to many of the properties present in the normal server definition. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzMySqlFlexibleServer -ResourceGroupName -ServerName [-SubscriptionId ] + [-AdministratorLoginPassword ] [-DelegatedSubnetArgumentSubnetArmResourceId ] + [-HaEnabled ] [-MaintenanceWindowCustomWindow ] [-MaintenanceWindowDayOfWeek ] + [-MaintenanceWindowStartHour ] [-MaintenanceWindowStartMinute ] + [-PublicNetworkAccess ] [-ReplicationRole ] [-SkuName ] + [-SkuTier ] [-SslEnforcement ] [-StorageProfileBackupRetentionDay ] + [-StorageProfileStorageAutogrow ] [-StorageProfileStorageIop ] + [-StorageProfileStorageMb ] [-Tag ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzMySqlFlexibleServer -InputObject [-AdministratorLoginPassword ] + [-DelegatedSubnetArgumentSubnetArmResourceId ] [-HaEnabled ] + [-MaintenanceWindowCustomWindow ] [-MaintenanceWindowDayOfWeek ] + [-MaintenanceWindowStartHour ] [-MaintenanceWindowStartMinute ] + [-PublicNetworkAccess ] [-ReplicationRole ] [-SkuName ] + [-SkuTier ] [-SslEnforcement ] [-StorageProfileBackupRetentionDay ] + [-StorageProfileStorageAutogrow ] [-StorageProfileStorageIop ] + [-StorageProfileStorageMb ] [-Tag ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Updates an existing server. +The request body can contain one to many of the properties present in the normal server definition. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AdministratorLoginPassword +The password of the administrator login. + +```yaml +Type: System.String +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 +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DelegatedSubnetArgumentSubnetArmResourceId +delegated subnet arm resource id. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HaEnabled +Enable HA or not for a server. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Support.HaEnabledEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +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 week 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 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 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 +``` + +### -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 +``` + +### -PublicNetworkAccess +Whether or not public network access is allowed for this server. +Value is optional but if passed in, must be 'Enabled' or 'Disabled' + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Support.PublicNetworkAccessEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationRole +The replication role of the server. + +```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 +``` + +### -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 +``` + +### -SkuName +The name of the sku, e.g. +Standard_D32s_v3. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkuTier +The tier of the particular SKU, e.g. +GeneralPurpose. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Support.SkuTier +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SslEnforcement +Enable ssl enforcement or not when connect to server. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Support.SslEnforcementEnum +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageProfileBackupRetentionDay +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 +``` + +### -StorageProfileStorageAutogrow +Enable Storage Auto Grow. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Support.StorageAutogrow +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -StorageProfileStorageIop +Storage IOPS for 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 +``` + +### -StorageProfileStorageMb +Max storage allowed for 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 +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Application-specific metadata in the form of key-value pairs. + +```yaml +Type: System.Collections.Hashtable +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.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20200701Privatepreview.IServerAutoGenerated + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[ConfigurationName ]`: The name of the server configuration. + - `[DatabaseName ]`: The name of the database. + - `[FirewallRuleName ]`: The name of the server firewall rule. + - `[Id ]`: Resource identity path + - `[KeyName ]`: The name of the server key. + - `[LocationName ]`: The name of the location. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName ]`: The name of the security alert policy. + - `[ServerName ]`: The name of the server. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[VirtualNetworkRuleName ]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/src/MySql/docs/Update-AzMySqlFlexibleServersConfiguration.md b/src/MySql/docs/Update-AzMySqlFlexibleServersConfiguration.md new file mode 100644 index 000000000000..c5ad67a1b44d --- /dev/null +++ b/src/MySql/docs/Update-AzMySqlFlexibleServersConfiguration.md @@ -0,0 +1,270 @@ +--- +external help file: +Module Name: Az.MySql +online version: https://docs.microsoft.com/en-us/powershell/module/az.mysql/update-azmysqlflexibleserversconfiguration +schema: 2.0.0 +--- + +# Update-AzMySqlFlexibleServersConfiguration + +## SYNOPSIS +Updates a configuration of a server. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzMySqlFlexibleServersConfiguration -ConfigurationName -ResourceGroupName + -ServerName [-SubscriptionId ] [-Source ] [-Value ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzMySqlFlexibleServersConfiguration -InputObject [-Source ] [-Value ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +## DESCRIPTION +Updates a configuration of a server. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ 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 +``` + +### -ConfigurationName +The name of the server configuration. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with Azure. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter +To construct, see NOTES section for INPUTOBJECT properties and create a hash table. + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.IMySqlIdentity +Parameter Sets: UpdateViaIdentityExpanded +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 +``` + +### -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 +``` + +### -Source +Source of the configuration. + +```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. + +```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 +``` + +### -Value +Value of the configuration. + +```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.MySql.Models.IMySqlIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.MySql.Models.Api20200701Privatepreview.IConfigurationAutoGenerated + +## NOTES + +ALIASES + +COMPLEX PARAMETER PROPERTIES + +To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. + + +INPUTOBJECT : Identity Parameter + - `[ConfigurationName ]`: The name of the server configuration. + - `[DatabaseName ]`: The name of the database. + - `[FirewallRuleName ]`: The name of the server firewall rule. + - `[Id ]`: Resource identity path + - `[KeyName ]`: The name of the server key. + - `[LocationName ]`: The name of the location. + - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. + - `[SecurityAlertPolicyName ]`: The name of the security alert policy. + - `[ServerName ]`: The name of the server. + - `[SubscriptionId ]`: The ID of the target subscription. + - `[VirtualNetworkRuleName ]`: The name of the virtual network rule. + +## RELATED LINKS + diff --git a/src/MySql/docs/Update-AzMySqlServer.md b/src/MySql/docs/Update-AzMySqlServer.md index 31a878f86612..c430adbd3387 100644 --- a/src/MySql/docs/Update-AzMySqlServer.md +++ b/src/MySql/docs/Update-AzMySqlServer.md @@ -394,6 +394,7 @@ INPUTOBJECT : Identity Parameter. - `[DatabaseName ]`: The name of the database. - `[FirewallRuleName ]`: The name of the server firewall rule. - `[Id ]`: Resource identity path + - `[KeyName ]`: The name of the server key. - `[LocationName ]`: The name of the location. - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - `[SecurityAlertPolicyName ]`: The name of the security alert policy. diff --git a/src/MySql/docs/Update-AzMySqlVirtualNetworkRule.md b/src/MySql/docs/Update-AzMySqlVirtualNetworkRule.md index 1a0be2260199..72812b741b8d 100644 --- a/src/MySql/docs/Update-AzMySqlVirtualNetworkRule.md +++ b/src/MySql/docs/Update-AzMySqlVirtualNetworkRule.md @@ -281,6 +281,7 @@ INPUTOBJECT : Identity Parameter - `[DatabaseName ]`: The name of the database. - `[FirewallRuleName ]`: The name of the server firewall rule. - `[Id ]`: Resource identity path + - `[KeyName ]`: The name of the server key. - `[LocationName ]`: The name of the location. - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - `[SecurityAlertPolicyName ]`: The name of the security alert policy. diff --git a/src/MySql/examples/Get-AzMySqlFlexibleServer.md b/src/MySql/examples/Get-AzMySqlFlexibleServer.md new file mode 100644 index 000000000000..093355d11d50 --- /dev/null +++ b/src/MySql/examples/Get-AzMySqlFlexibleServer.md @@ -0,0 +1,18 @@ +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + diff --git a/src/MySql/examples/Get-AzMySqlFlexibleServerConfiguration.md b/src/MySql/examples/Get-AzMySqlFlexibleServerConfiguration.md new file mode 100644 index 000000000000..093355d11d50 --- /dev/null +++ b/src/MySql/examples/Get-AzMySqlFlexibleServerConfiguration.md @@ -0,0 +1,18 @@ +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + diff --git a/src/MySql/examples/Get-AzMySqlFlexibleServerDatabase.md b/src/MySql/examples/Get-AzMySqlFlexibleServerDatabase.md new file mode 100644 index 000000000000..093355d11d50 --- /dev/null +++ b/src/MySql/examples/Get-AzMySqlFlexibleServerDatabase.md @@ -0,0 +1,18 @@ +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + diff --git a/src/MySql/examples/Get-AzMySqlFlexibleServerFirewallRule.md b/src/MySql/examples/Get-AzMySqlFlexibleServerFirewallRule.md new file mode 100644 index 000000000000..093355d11d50 --- /dev/null +++ b/src/MySql/examples/Get-AzMySqlFlexibleServerFirewallRule.md @@ -0,0 +1,18 @@ +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + diff --git a/src/MySql/examples/Get-AzMySqlFlexibleServerKey.md b/src/MySql/examples/Get-AzMySqlFlexibleServerKey.md new file mode 100644 index 000000000000..093355d11d50 --- /dev/null +++ b/src/MySql/examples/Get-AzMySqlFlexibleServerKey.md @@ -0,0 +1,18 @@ +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + diff --git a/src/MySql/examples/Get-AzMySqlFlexibleServerReplica.md b/src/MySql/examples/Get-AzMySqlFlexibleServerReplica.md new file mode 100644 index 000000000000..093355d11d50 --- /dev/null +++ b/src/MySql/examples/Get-AzMySqlFlexibleServerReplica.md @@ -0,0 +1,18 @@ +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + diff --git a/src/MySql/examples/Get-AzMySqlFlexibleServersConfiguration.md b/src/MySql/examples/Get-AzMySqlFlexibleServersConfiguration.md new file mode 100644 index 000000000000..093355d11d50 --- /dev/null +++ b/src/MySql/examples/Get-AzMySqlFlexibleServersConfiguration.md @@ -0,0 +1,18 @@ +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + diff --git a/src/MySql/examples/Get-AzMySqlFlexibleServersDatabase.md b/src/MySql/examples/Get-AzMySqlFlexibleServersDatabase.md new file mode 100644 index 000000000000..093355d11d50 --- /dev/null +++ b/src/MySql/examples/Get-AzMySqlFlexibleServersDatabase.md @@ -0,0 +1,18 @@ +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + diff --git a/src/MySql/examples/Get-AzMySqlFlexibleServersFirewallRule.md b/src/MySql/examples/Get-AzMySqlFlexibleServersFirewallRule.md new file mode 100644 index 000000000000..093355d11d50 --- /dev/null +++ b/src/MySql/examples/Get-AzMySqlFlexibleServersFirewallRule.md @@ -0,0 +1,18 @@ +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + diff --git a/src/MySql/examples/Get-AzMySqlLocationBasedCapability.md b/src/MySql/examples/Get-AzMySqlLocationBasedCapability.md new file mode 100644 index 000000000000..093355d11d50 --- /dev/null +++ b/src/MySql/examples/Get-AzMySqlLocationBasedCapability.md @@ -0,0 +1,18 @@ +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + diff --git a/src/MySql/examples/Get-AzMySqlVirtualNetworkSubnetUsage.md b/src/MySql/examples/Get-AzMySqlVirtualNetworkSubnetUsage.md new file mode 100644 index 000000000000..093355d11d50 --- /dev/null +++ b/src/MySql/examples/Get-AzMySqlVirtualNetworkSubnetUsage.md @@ -0,0 +1,18 @@ +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + diff --git a/src/MySql/examples/New-AzMySqlFlexibleServer.md b/src/MySql/examples/New-AzMySqlFlexibleServer.md new file mode 100644 index 000000000000..093355d11d50 --- /dev/null +++ b/src/MySql/examples/New-AzMySqlFlexibleServer.md @@ -0,0 +1,18 @@ +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + diff --git a/src/MySql/examples/New-AzMySqlFlexibleServerDatabase.md b/src/MySql/examples/New-AzMySqlFlexibleServerDatabase.md new file mode 100644 index 000000000000..093355d11d50 --- /dev/null +++ b/src/MySql/examples/New-AzMySqlFlexibleServerDatabase.md @@ -0,0 +1,18 @@ +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + diff --git a/src/MySql/examples/New-AzMySqlFlexibleServerFirewallRule.md b/src/MySql/examples/New-AzMySqlFlexibleServerFirewallRule.md new file mode 100644 index 000000000000..093355d11d50 --- /dev/null +++ b/src/MySql/examples/New-AzMySqlFlexibleServerFirewallRule.md @@ -0,0 +1,18 @@ +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + diff --git a/src/MySql/examples/New-AzMySqlFlexibleServerKey.md b/src/MySql/examples/New-AzMySqlFlexibleServerKey.md new file mode 100644 index 000000000000..093355d11d50 --- /dev/null +++ b/src/MySql/examples/New-AzMySqlFlexibleServerKey.md @@ -0,0 +1,18 @@ +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + diff --git a/src/MySql/examples/New-AzMySqlVirtualNetworkRule.md b/src/MySql/examples/New-AzMySqlVirtualNetworkRule.md index 9b5f3354f121..093355d11d50 100644 --- a/src/MySql/examples/New-AzMySqlVirtualNetworkRule.md +++ b/src/MySql/examples/New-AzMySqlVirtualNetworkRule.md @@ -1,11 +1,18 @@ -### Example 1: Create a new MySql server Virtual Network Rule +### Example 1: {{ Add title here }} ```powershell -PS C:\> $ID = "/subscriptions//resourceGroups/PowershellMySqlTest/providers/Microsoft.Network/virtualNetworks/MySqlVNet/subnets/MysqlSubnet1" -PS C:\> New-AzMySqlVirtualNetworkRule -Name vnet -ResourceGroupName PowershellMySqlTest -ServerName mysql-test -SubnetId $ID +PS C:\> {{ Add code here }} -Name Type ----- ---- -vnet Microsoft.DBforMySQL/servers/virtualNetworkRules +{{ Add output here }} ``` -These cmdlets create a MySql server Virtual Network Rule. \ No newline at end of file +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + diff --git a/src/MySql/examples/Remove-AzMySqlFlexibleServer.md b/src/MySql/examples/Remove-AzMySqlFlexibleServer.md new file mode 100644 index 000000000000..093355d11d50 --- /dev/null +++ b/src/MySql/examples/Remove-AzMySqlFlexibleServer.md @@ -0,0 +1,18 @@ +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + diff --git a/src/MySql/examples/Remove-AzMySqlFlexibleServerKey.md b/src/MySql/examples/Remove-AzMySqlFlexibleServerKey.md new file mode 100644 index 000000000000..093355d11d50 --- /dev/null +++ b/src/MySql/examples/Remove-AzMySqlFlexibleServerKey.md @@ -0,0 +1,18 @@ +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + diff --git a/src/MySql/examples/Remove-AzMySqlFlexibleServersDatabase.md b/src/MySql/examples/Remove-AzMySqlFlexibleServersDatabase.md new file mode 100644 index 000000000000..093355d11d50 --- /dev/null +++ b/src/MySql/examples/Remove-AzMySqlFlexibleServersDatabase.md @@ -0,0 +1,18 @@ +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + diff --git a/src/MySql/examples/Remove-AzMySqlFlexibleServersFirewallRule.md b/src/MySql/examples/Remove-AzMySqlFlexibleServersFirewallRule.md new file mode 100644 index 000000000000..093355d11d50 --- /dev/null +++ b/src/MySql/examples/Remove-AzMySqlFlexibleServersFirewallRule.md @@ -0,0 +1,18 @@ +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + diff --git a/src/MySql/examples/Restart-AzMySqlFlexibleServer.md b/src/MySql/examples/Restart-AzMySqlFlexibleServer.md new file mode 100644 index 000000000000..093355d11d50 --- /dev/null +++ b/src/MySql/examples/Restart-AzMySqlFlexibleServer.md @@ -0,0 +1,18 @@ +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + diff --git a/src/MySql/examples/Set-AzMySqlFlexibleServerDatabase.md b/src/MySql/examples/Set-AzMySqlFlexibleServerDatabase.md new file mode 100644 index 000000000000..093355d11d50 --- /dev/null +++ b/src/MySql/examples/Set-AzMySqlFlexibleServerDatabase.md @@ -0,0 +1,18 @@ +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + diff --git a/src/MySql/examples/Set-AzMySqlFlexibleServerFirewallRule.md b/src/MySql/examples/Set-AzMySqlFlexibleServerFirewallRule.md new file mode 100644 index 000000000000..093355d11d50 --- /dev/null +++ b/src/MySql/examples/Set-AzMySqlFlexibleServerFirewallRule.md @@ -0,0 +1,18 @@ +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + diff --git a/src/MySql/examples/Set-AzMySqlFlexibleServerKey.md b/src/MySql/examples/Set-AzMySqlFlexibleServerKey.md new file mode 100644 index 000000000000..093355d11d50 --- /dev/null +++ b/src/MySql/examples/Set-AzMySqlFlexibleServerKey.md @@ -0,0 +1,18 @@ +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + diff --git a/src/MySql/examples/Start-AzMySqlFlexibleServer.md b/src/MySql/examples/Start-AzMySqlFlexibleServer.md new file mode 100644 index 000000000000..093355d11d50 --- /dev/null +++ b/src/MySql/examples/Start-AzMySqlFlexibleServer.md @@ -0,0 +1,18 @@ +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + diff --git a/src/MySql/examples/Stop-AzMySqlFlexibleServer.md b/src/MySql/examples/Stop-AzMySqlFlexibleServer.md new file mode 100644 index 000000000000..093355d11d50 --- /dev/null +++ b/src/MySql/examples/Stop-AzMySqlFlexibleServer.md @@ -0,0 +1,18 @@ +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + diff --git a/src/MySql/examples/Test-AzMySqlFlexibleServersNameAvailability.md b/src/MySql/examples/Test-AzMySqlFlexibleServersNameAvailability.md new file mode 100644 index 000000000000..093355d11d50 --- /dev/null +++ b/src/MySql/examples/Test-AzMySqlFlexibleServersNameAvailability.md @@ -0,0 +1,18 @@ +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + diff --git a/src/MySql/examples/Test-AzMySqlNameAvailability.md b/src/MySql/examples/Test-AzMySqlNameAvailability.md new file mode 100644 index 000000000000..093355d11d50 --- /dev/null +++ b/src/MySql/examples/Test-AzMySqlNameAvailability.md @@ -0,0 +1,18 @@ +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + diff --git a/src/MySql/examples/Update-AzMySqlFlexibleServer.md b/src/MySql/examples/Update-AzMySqlFlexibleServer.md new file mode 100644 index 000000000000..093355d11d50 --- /dev/null +++ b/src/MySql/examples/Update-AzMySqlFlexibleServer.md @@ -0,0 +1,18 @@ +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + diff --git a/src/MySql/examples/Update-AzMySqlFlexibleServersConfiguration.md b/src/MySql/examples/Update-AzMySqlFlexibleServersConfiguration.md new file mode 100644 index 000000000000..093355d11d50 --- /dev/null +++ b/src/MySql/examples/Update-AzMySqlFlexibleServersConfiguration.md @@ -0,0 +1,18 @@ +### Example 1: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +PS C:\> {{ Add code here }} + +{{ Add output here }} +``` + +{{ Add description here }} + diff --git a/src/MySql/readme.md b/src/MySql/readme.md index 22e9328aecbf..5f53c85a2451 100644 --- a/src/MySql/readme.md +++ b/src/MySql/readme.md @@ -17,7 +17,7 @@ This directory contains the PowerShell module for the MySql service. 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 1.7.4 or greater +- [Az.Accounts module](https://www.powershellgallery.com/packages/Az.Accounts/), version 1.8.1 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. @@ -53,25 +53,38 @@ require: input-file: - $(repo)/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/mysql.json - $(repo)/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/ServerSecurityAlertPolicies.json + - $(repo)/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/mysql.json module-version: 0.1.0 title: MySQL subject-prefix: 'MySQL' directive: - - from: mysql.json + - from: swagger-document + where: $.paths..operationId + transform: return $.replace(/^CheckNameAvailability_Execute$/g, "NameAvailability_Test") + - from: Microsoft.DBforMySQL/stable/2017-12-01/mysql.json where: $.definitions.VirtualNetworkRule transform: $['required'] = ['properties'] + - from: Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/mysql.json + where: $.paths..operationId + transform: return $.replace(/^(Servers|ServerKeys)_/g, "flexible$1_") + - from: Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/mysql.json + where: $.paths..operationId + transform: return $.replace(/^(Replicas|FirewallRules|Databases|Configurations|NameAvailability)_/g, "flexibleServers$1_") + - from: Microsoft.DBforMySQL/preview/2020-07-01-privatepreview/mysql.json + where: $.paths..operationId + transform: return $.replace(/^CheckVirtualNetworkSubnetUsage_Execute$/g, "VirtualNetworkSubnetUsage_Get") - where: verb: Set - subject: Configuration$|FirewallRule$|VirtualNetworkRule$ + subject: ^Configuration$|^FirewallRule$|^VirtualNetworkRule$ set: verb: Update - where: - subject: Database$|SecurityAlertPolicy$|Administrator$|LocationBasedPerformanceTier$|LogFile$|ExecuteCheckNameAvailability$ + subject: ^Database$|^LocationBasedPerformanceTier$|^LogFile$|SecurityAlertPolicy$|Administrator$ hide: true - where: verb: New$|Update$ - subject: Server$|Configuration$|FirewallRule$ + subject: ^Server$|^Configuration$|^FirewallRule$ hide: true - where: verb: New$