From 5e1df941543ab21f52bc8de335d9eedf34909ab1 Mon Sep 17 00:00:00 2001 From: Youri Date: Fri, 8 Jan 2021 17:09:39 +0800 Subject: [PATCH] Delete comdlet --- .../Sql/help/Set-AzSqlServerMSSupportAudit.md | 351 ------------------ 1 file changed, 351 deletions(-) delete mode 100644 src/Sql/Sql/help/Set-AzSqlServerMSSupportAudit.md diff --git a/src/Sql/Sql/help/Set-AzSqlServerMSSupportAudit.md b/src/Sql/Sql/help/Set-AzSqlServerMSSupportAudit.md deleted file mode 100644 index 53714191c7f0..000000000000 --- a/src/Sql/Sql/help/Set-AzSqlServerMSSupportAudit.md +++ /dev/null @@ -1,351 +0,0 @@ ---- -external help file: Microsoft.Azure.PowerShell.Cmdlets.Sql.dll-Help.xml -Module Name: Az.Sql -ms.assetid: 14814BF3-51AF-4E51-A8A6-661825BD88D1 -online version: https://docs.microsoft.com/en-us/powershell/module/az.sql/Set-AzSqlServerMSSupportAudit -schema: 2.0.0 ---- - -# Set-AzSqlServerMSSupportAudit - -## SYNOPSIS -Changes the Microsoft support operations auditing settings of an Azure SQL server. - -## SYNTAX - -### ServerParameterSet (Default) -``` -Set-AzSqlServerMSSupportAudit - [-BlobStorageTargetState ] [-StorageAccountResourceId ] - [-EventHubTargetState ] [-EventHubName ] [-EventHubAuthorizationRuleResourceId ] - [-LogAnalyticsTargetState ] [-WorkspaceResourceId ] - [-PassThru] [-ResourceGroupName] [-ServerName] [-AsJob] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### ServerObjectParameterSet -``` -Set-AzSqlServerMSSupportAudit [-BlobStorageTargetState ] [-StorageAccountResourceId ] - [-EventHubTargetState ] [-EventHubName ] - [-EventHubAuthorizationRuleResourceId ] [-LogAnalyticsTargetState ] - [-WorkspaceResourceId ] [-PassThru] -ServerObject [-AsJob] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Set-AzSqlServerMSSupportAudit** cmdlet changes the Microsoft support operations auditing settings of an Azure SQL server. -To use the cmdlet, use the *ResourceGroupName* and *ServerName* parameters to identify the server. -When blob storage is a destination for audit logs, specify the *StorageAccountResourceId* parameter to determine the storage account for the audit logs. - -## EXAMPLES - -### Example 1: Enable the blob storage Microsoft support operations auditing policy of an Azure SQL server -```powershell -PS C:\>Set-AzSqlServerMSSupportAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -BlobStorageTargetState Enabled -StorageAccountResourceId "/subscriptions/7fe3301d-31d3-4668-af5e-211a890ba6e3/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage" -``` - -### Example 2: Disable the blob storage Microsoft support operations auditing policy of an Azure SQL server -```powershell -PS C:\>Set-AzSqlServerMSSupportAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -BlobStorageTargetState Disabled -``` - -### Example 3: Enable the event hub Microsoft support operations auditing policy of an Azure SQL server -```powershell -PS C:\>Set-AzSqlServerMSSupportAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -EventHubTargetState Enabled -EventHubName "EventHubName" -EventHubAuthorizationRuleResourceId "EventHubAuthorizationRuleResourceId" -``` - -### Example 4: Disable the event hub Microsoft support operations auditing policy of an Azure SQL server -```powershell -PS C:\>Set-AzSqlServerMSSupportAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -EventHubTargetState Disabled -``` - -### Example 5: Enable the log analytics Microsoft support operations auditing policy of an Azure SQL server -```powershell -PS C:\>Set-AzSqlServerMSSupportAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -LogAnalyticsTargetState Enabled -WorkspaceResourceId "/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2" -``` - -### Example 6: Disable the log analytics Microsoft support operations auditing policy of an Azure SQL server -```powershell -PS C:\>Set-AzSqlServerMSSupportAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -LogAnalyticsTargetState Disabled -``` - -### Example 7: Disable, through pipeline, the log analytics Microsoft support operations auditing policy of an Azure SQL server -```powershell -PS C:\>Get-AzSqlServer -ResourceGroupName "ResourceGroup01" -ServerName "Server01" | Set-AzSqlServerMSSupportAudit -LogAnalyticsTargetState Disabled -``` - -### Example 8: Disable sending Microsoft support operations audit records of an Azure SQL server to blob storage, and enable sending them to log analytics. -```powershell -PS C:\>Set-AzSqlServerMSSupportAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -LogAnalyticsTargetState Enabled -WorkspaceResourceId "/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2" -BlobStorageTargetState Disabled -``` - -### Example 9: Enable sending Microsoft support operations audit records of an Azure SQL server to blob storage, event hub and log analytics. -```powershell -PS C:\>Set-AzSqlServerMSSupportAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -BlobStorageTargetState Enabled -StorageAccountResourceId "/subscriptions/7fe3301d-31d3-4668-af5e-211a890ba6e3/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage" -EventHubTargetState Enabled -EventHubName "EventHubName" -EventHubAuthorizationRuleResourceId "EventHubAuthorizationRuleResourceId" -LogAnalyticsTargetState Enabled -WorkspaceResourceId "/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2" -``` - -## PARAMETERS - -### -AsJob -Run cmdlet in the background - -```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 -``` - -### -BlobStorageTargetState -Indicates whether blob storage is a destination for Microsoft support operations audit records. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -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: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer -Parameter Sets: (All) -Aliases: AzContext, AzureRmContext, AzureCredential - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventHubAuthorizationRuleResourceId -The resource Id for the event hub authorization rule - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventHubName -The name of the event hub. If none is specified when providing EventHubAuthorizationRuleResourceId, the default event hub will be selected. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventHubTargetState -Indicates whether event hub is a destination for Microsoft support operations audit records. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogAnalyticsTargetState -Indicates whether log analytics is a destination for Microsoft support operations audit records. - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Enabled, Disabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Specifies whether to output the Microsoft support operations auditing policy at end of cmdlet execution - -```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. - -```yaml -Type: System.String -Parameter Sets: ServerParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerName -SQL server name. - -```yaml -Type: System.String -Parameter Sets: ServerParameterSet -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerObject -The server object to manage its Microsoft support operations audit policy. - -```yaml -Type: Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel -Parameter Sets: ServerObjectParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -StorageAccountResourceId -The storage account 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 -``` - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: -Accepted values: Primary, Secondary - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkspaceResourceId -The workspace ID (resource ID of a Log Analytics workspace) for a Log Analytics workspace to which you would like to send Microsoft support operations Audit Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 - -```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 - -### System.String - -### Microsoft.Azure.Commands.Sql.Server.Model.AzureSqlServerModel - -### System.Guid - -### System.Nullable`1[[System.UInt32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] - -### Microsoft.Azure.Commands.Sql.Auditing.Model.ServerDevOpsAuditModel - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS