diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchAutoScale.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchAutoScale.md index ac0f57ec9326..ee296e597489 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchAutoScale.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchAutoScale.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 9C755BE8-0624-4CF7-AE7C-34DAF44678E8 online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Disables automatic scaling of a pool. ## SYNTAX ``` -Disable-AzureBatchAutoScale [-Id] -BatchContext [] +Disable-AzureBatchAutoScale [-Id] -BatchContext + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -46,6 +48,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id Specifies the object ID of the pool. @@ -67,11 +84,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### String - Parameter 'Id' accepts value of type 'String' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchComputeNodeScheduling.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchComputeNodeScheduling.md index da8dd5791e7a..7598a80f8537 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchComputeNodeScheduling.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchComputeNodeScheduling.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 2DF5FB4D-A5CB-439C-AC6F-DF2130AF33EC online version: schema: 2.0.0 @@ -16,14 +17,14 @@ Disables task scheduling on the specified compute node. ``` Disable-AzureBatchComputeNodeScheduling [-PoolId] [-Id] [-DisableSchedulingOption ] -BatchContext - [] + [-DefaultProfile ] [] ``` ### InputObject ``` Disable-AzureBatchComputeNodeScheduling [[-ComputeNode] ] [-DisableSchedulingOption ] -BatchContext - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -104,6 +105,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DisableSchedulingOption Specifies how this cmdlet deals with any tasks currently running on the computer node where scheduling is being disabled. The acceptable values for this parameter are: @@ -173,11 +189,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### PSComputeNode - Parameter 'ComputeNode' accepts value of type 'PSComputeNode' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchJob.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchJob.md index 9e1af19e9f41..8aa73613c447 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchJob.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchJob.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: C831F934-7513-4882-A155-816E56CD9807 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Disables a Batch job. ``` Disable-AzureBatchJob [-Id] [-DisableJobOption] -BatchContext - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -52,6 +53,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DisableJobOption Specifies what to do with active tasks associated with the job that this cmdlet disables. Valid values are: @@ -94,11 +110,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### String - Parameter 'Id' accepts value of type 'String' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchJobSchedule.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchJobSchedule.md index 3271c171edb2..68f35aa23a90 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchJobSchedule.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Disable-AzureBatchJobSchedule.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: B4737AE8-F57C-4B95-B81E-74802EF8E7AE online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Disables a Batch job schedule. ## SYNTAX ``` -Disable-AzureBatchJobSchedule [-Id] -BatchContext [] +Disable-AzureBatchJobSchedule [-Id] -BatchContext + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -49,6 +51,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id Specifies the ID of the job schedule that this cmdlet disables. @@ -70,11 +87,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### String - Parameter 'Id' accepts value of type 'String' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchAutoScale.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchAutoScale.md index 61ed5ce52749..54a4dadd0523 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchAutoScale.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchAutoScale.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 3107D061-7F25-45D0-8029-C99120A156DA online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Enables automatic scaling of a pool. ``` Enable-AzureBatchAutoScale [-Id] [[-AutoScaleFormula] ] - [[-AutoScaleEvaluationInterval] ] -BatchContext [] + [[-AutoScaleEvaluationInterval] ] -BatchContext + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -81,6 +83,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id Specifies the object ID of the pool for which to enable automatic scaling. @@ -102,11 +119,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### String - Parameter 'Id' accepts value of type 'String' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchComputeNodeScheduling.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchComputeNodeScheduling.md index a946a7ecb976..8b83f02ca074 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchComputeNodeScheduling.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchComputeNodeScheduling.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 36EB9CE6-EAC9-471C-97D6-14E882E0F710 online version: schema: 2.0.0 @@ -15,13 +16,13 @@ Enables task scheduling on the specified compute node. ### Id (Default) ``` Enable-AzureBatchComputeNodeScheduling [-PoolId] [-Id] -BatchContext - [] + [-DefaultProfile ] [] ``` ### InputObject ``` Enable-AzureBatchComputeNodeScheduling [[-ComputeNode] ] -BatchContext - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -89,6 +90,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id Specifies the ID of the compute node where task scheduling is enabled. @@ -125,11 +141,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### PSComputeNode - Parameter 'ComputeNode' accepts value of type 'PSComputeNode' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchJob.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchJob.md index 2ccaaab51ef5..4add81d9e57b 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchJob.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchJob.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 7C79BFF1-41E1-472D-AF67-1C3B39AB7548 online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Enables a Batch job. ## SYNTAX ``` -Enable-AzureBatchJob [-Id] -BatchContext [] +Enable-AzureBatchJob [-Id] -BatchContext + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -48,6 +50,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id Specifies the ID of the job that this cmdlet enables. @@ -69,11 +86,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### String - Parameter 'Id' accepts value of type 'String' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchJobSchedule.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchJobSchedule.md index 322946f38b56..9f09e6c60f2a 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchJobSchedule.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchJobSchedule.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 02F91510-F14F-4401-BC5F-06B0874AEB4B online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Enables a Batch job schedule. ## SYNTAX ``` -Enable-AzureBatchJobSchedule [-Id] -BatchContext [] +Enable-AzureBatchJobSchedule [-Id] -BatchContext + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -48,6 +50,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id Specifies the ID of the job schedule that this cmdlet enables. @@ -69,11 +86,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### String - Parameter 'Id' accepts value of type 'String' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchTask.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchTask.md index 595baf28b6ab..ca5bc2177ace 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchTask.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Enable-AzureBatchTask.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 67FB5D02-4F4B-4119-B3AC-0D205247253E online version: schema: 2.0.0 @@ -14,14 +15,14 @@ Reactivates a task. ### Id ``` -Enable-AzureBatchTask [-JobId] [-Id] -BatchContext [-WhatIf] [-Confirm] - [] +Enable-AzureBatchTask [-JobId] [-Id] -BatchContext + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### InputObject ``` -Enable-AzureBatchTask [-Task] -BatchContext [-WhatIf] [-Confirm] - [] +Enable-AzureBatchTask [-Task] -BatchContext + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -64,6 +65,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id Specifies the ID of the task to reactivate. @@ -147,11 +163,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### PSCloudTask - Parameter 'Task' accepts value of type 'PSCloudTask' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchCertificate.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchCertificate.md index 69bfacd98ca3..e953bf40ae44 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchCertificate.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchCertificate.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: A9C98F8F-90F2-4BF4-A234-31966FBB975B online version: schema: 2.0.0 @@ -15,13 +16,13 @@ Gets the certificates in a Batch account. ### ODataFilter (Default) ``` Get-AzureBatchCertificate [-Filter ] [-MaxCount ] [-Select ] - -BatchContext [] + -BatchContext [-DefaultProfile ] [] ``` ### Thumbprint ``` Get-AzureBatchCertificate [-ThumbprintAlgorithm] [-Thumbprint] [-Select ] - -BatchContext [] + -BatchContext [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -118,6 +119,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Filter Specifies an OData filter clause. If you specify this parameter, this cmdlet gets the certificates that match the filter. @@ -204,7 +220,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchComputeNode.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchComputeNode.md index b82d183a1f5a..5d336b750b15 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchComputeNode.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchComputeNode.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 93614655-A8F2-4A67-887D-43D41AB91F82 online version: schema: 2.0.0 @@ -15,19 +16,19 @@ Gets Batch compute nodes from a pool. ### ODataFilter (Default) ``` Get-AzureBatchComputeNode [-PoolId] [-Filter ] [-MaxCount ] [-Select ] - -BatchContext [] + -BatchContext [-DefaultProfile ] [] ``` ### Id ``` Get-AzureBatchComputeNode [-PoolId] [[-Id] ] [-Select ] - -BatchContext [] + -BatchContext [-DefaultProfile ] [] ``` ### ParentObject ``` Get-AzureBatchComputeNode [[-Pool] ] [-Filter ] [-MaxCount ] [-Select ] - -BatchContext [] + -BatchContext [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -160,6 +161,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Filter Specifies an OData filter clause. This cmdlet returns compute nodes that match the filter that this parameter specifies. @@ -263,11 +279,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### PSCloudPool - Parameter 'Pool' accepts value of type 'PSCloudPool' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJob.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJob.md index 5082a9b642c4..fe0b6f1d875b 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJob.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJob.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 8BF49C4D-E7CD-4FD0-AFAC-9856239D24EC online version: schema: 2.0.0 @@ -15,19 +16,21 @@ Gets Batch jobs for a Batch account or job schedule. ### ODataFilter (Default) ``` Get-AzureBatchJob [-JobScheduleId ] [-Filter ] [-MaxCount ] [-Select ] - [-Expand ] -BatchContext [] + [-Expand ] -BatchContext [-DefaultProfile ] + [] ``` ### Id ``` Get-AzureBatchJob [[-Id] ] [-Select ] [-Expand ] -BatchContext - [] + [-DefaultProfile ] [] ``` ### ParentObject ``` Get-AzureBatchJob [[-JobSchedule] ] [-Filter ] [-MaxCount ] - [-Select ] [-Expand ] -BatchContext [] + [-Select ] [-Expand ] -BatchContext + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -140,6 +143,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Expand Specifies an Open Data Protocol (OData) expand clause. Specify a value for this parameter to get associated entities of the main entity that you get. @@ -258,11 +276,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### PSCloudJobSchedule - Parameter 'JobSchedule' accepts value of type 'PSCloudJobSchedule' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJobPreparationAndReleaseTaskStatus.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJobPreparationAndReleaseTaskStatus.md index b3cddcf7145b..cd2e54a192c2 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJobPreparationAndReleaseTaskStatus.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJobPreparationAndReleaseTaskStatus.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch online version: schema: 2.0.0 --- @@ -14,14 +15,15 @@ Gets Batch job preparation and release task status. ### Id (Default) ``` Get-AzureBatchJobPreparationAndReleaseTaskStatus [-Id] [-Filter ] [-MaxCount ] - [-Select ] [-Expand ] -BatchContext [] + [-Select ] [-Expand ] -BatchContext + [-DefaultProfile ] [] ``` ### InputObject ``` Get-AzureBatchJobPreparationAndReleaseTaskStatus [-InputObject] [-Filter ] [-MaxCount ] [-Select ] [-Expand ] -BatchContext - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -75,6 +77,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Expand Specifies an Open Data Protocol (OData) expand clause. Specify a value for this parameter to get associated entities of the main entity that you get. diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJobSchedule.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJobSchedule.md index 183854763372..3bcee4a597a2 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJobSchedule.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJobSchedule.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 8BAA6D8C-1530-4CC4-8AE5-A2CE6B1192CA online version: schema: 2.0.0 @@ -15,13 +16,13 @@ Gets Batch job schedules. ### ODataFilter (Default) ``` Get-AzureBatchJobSchedule [-Filter ] [-MaxCount ] [-Select ] [-Expand ] - -BatchContext [] + -BatchContext [-DefaultProfile ] [] ``` ### Id ``` Get-AzureBatchJobSchedule [[-Id] ] [-Select ] [-Expand ] - -BatchContext [] + -BatchContext [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -110,6 +111,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Expand Specifies an Open Data Protocol (OData) expand clause. Specify a value for this parameter to get associated entities of the main entity that you get. @@ -198,11 +214,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### String - Parameter 'Id' accepts value of type 'String' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJobStatistics.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJobStatistics.md index 636ed5bbecc7..233506d03ecb 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJobStatistics.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchJobStatistics.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: E655684D-9601-4A0B-BB09-EFB787EB2B1B online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Gets job summary statistics for a Batch account. ## SYNTAX ``` -Get-AzureBatchJobStatistics -BatchContext [] +Get-AzureBatchJobStatistics -BatchContext [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -65,13 +67,27 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +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 ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeAgentSku.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeAgentSku.md index 0b09e9a017b7..09a36e751017 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeAgentSku.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeAgentSku.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 5C6D3792-AA56-4210-B376-D9E656B04FBD online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets Batch node agent SKUs available in a Batch account. ``` Get-AzureBatchNodeAgentSku [-Filter ] [-MaxCount ] -BatchContext - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -59,6 +60,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Filter Specifies an OData filter clause for node agent SKUs. If you do not specify a filter, this cmdlet returns all node agent SKUs that Batch supports. @@ -96,7 +112,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeFile.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeFile.md index c7fd6dd75ab6..cabe7ed46bff 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeFile.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeFile.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 38ED2854-23D0-400E-A5C8-239346B2AF99 online version: schema: 2.0.0 @@ -15,37 +16,38 @@ Gets the properties of Batch node files. ### ComputeNode_Id (Default) ``` Get-AzureBatchNodeFile [-PoolId] [-ComputeNodeId] [[-Name] ] - -BatchContext [] + -BatchContext [-DefaultProfile ] [] ``` ### Task_Id ``` Get-AzureBatchNodeFile -JobId -TaskId [[-Name] ] -BatchContext - [] + [-DefaultProfile ] [] ``` ### Task_ODataFilter ``` Get-AzureBatchNodeFile -JobId -TaskId [-Filter ] [-MaxCount ] [-Recursive] - -BatchContext [] + -BatchContext [-DefaultProfile ] [] ``` ### ParentTask ``` Get-AzureBatchNodeFile [[-Task] ] [-Filter ] [-MaxCount ] [-Recursive] - -BatchContext [] + -BatchContext [-DefaultProfile ] [] ``` ### ComputeNode_ODataFilter ``` Get-AzureBatchNodeFile [-PoolId] [-ComputeNodeId] [-Filter ] [-MaxCount ] - [-Recursive] -BatchContext [] + [-Recursive] -BatchContext [-DefaultProfile ] + [] ``` ### ParentComputeNode ``` Get-AzureBatchNodeFile [[-ComputeNode] ] [-Filter ] [-MaxCount ] [-Recursive] - -BatchContext [] + -BatchContext [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -186,6 +188,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Filter Specifies an OData filter clause. This cmdlet returns properties for node files that match the filter that this parameter specifies. @@ -318,15 +335,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### PSComputeNode - Parameter 'ComputeNode' accepts value of type 'PSComputeNode' from the pipeline ### PSCloudTask - Parameter 'Task' accepts value of type 'PSCloudTask' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeFileContent.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeFileContent.md index 42712047bfd3..089973dc42fb 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeFileContent.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchNodeFileContent.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: C9E2D9EC-3B6A-492D-B183-9856185548CD online version: schema: 2.0.0 @@ -15,39 +16,43 @@ Gets a Batch node file. ### Task_Id_Path ``` Get-AzureBatchNodeFileContent -JobId -TaskId [-Name] -DestinationPath - [-ByteRangeStart ] [-ByteRangeEnd ] -BatchContext [] + [-ByteRangeStart ] [-ByteRangeEnd ] -BatchContext + [-DefaultProfile ] [] ``` ### Task_Id_Stream ``` Get-AzureBatchNodeFileContent -JobId -TaskId [-Name] -DestinationStream - [-ByteRangeStart ] [-ByteRangeEnd ] -BatchContext [] + [-ByteRangeStart ] [-ByteRangeEnd ] -BatchContext + [-DefaultProfile ] [] ``` ### ComputeNode_Id_Path ``` Get-AzureBatchNodeFileContent [-PoolId] [-ComputeNodeId] [-Name] -DestinationPath [-ByteRangeStart ] [-ByteRangeEnd ] - -BatchContext [] + -BatchContext [-DefaultProfile ] [] ``` ### ComputeNode_Id_Stream ``` Get-AzureBatchNodeFileContent [-PoolId] [-ComputeNodeId] [-Name] -DestinationStream [-ByteRangeStart ] [-ByteRangeEnd ] - -BatchContext [] + -BatchContext [-DefaultProfile ] [] ``` ### InputObject_Path ``` Get-AzureBatchNodeFileContent [[-InputObject] ] -DestinationPath [-ByteRangeStart ] - [-ByteRangeEnd ] -BatchContext [] + [-ByteRangeEnd ] -BatchContext [-DefaultProfile ] + [] ``` ### InputObject_Stream ``` Get-AzureBatchNodeFileContent [[-InputObject] ] -DestinationStream - [-ByteRangeStart ] [-ByteRangeEnd ] -BatchContext [] + [-ByteRangeStart ] [-ByteRangeEnd ] -BatchContext + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -175,6 +180,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DestinationPath Specifies the file path where this cmdlet saves the node file. @@ -289,11 +309,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### PSNodeFile - Parameter 'InputObject' accepts value of type 'PSNodeFile' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPool.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPool.md index 5c78f8be3689..c073b3f16733 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPool.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPool.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 44D877F1-D066-4C9C-A797-05EF03785B54 online version: schema: 2.0.0 @@ -15,13 +16,13 @@ Gets Batch pools under the specified Batch account. ### ODataFilter (Default) ``` Get-AzureBatchPool [-Filter ] [-MaxCount ] [-Select ] [-Expand ] - -BatchContext [] + -BatchContext [-DefaultProfile ] [] ``` ### Id ``` Get-AzureBatchPool [[-Id] ] [-Select ] [-Expand ] -BatchContext - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -118,6 +119,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Expand Specifies an Open Data Protocol (OData) expand clause. Specify a value for this parameter to get associated entities of the main entity that you get. @@ -205,11 +221,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### String - Parameter 'Id' accepts value of type 'String' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPoolStatistics.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPoolStatistics.md index e00647d0778a..157c188d116b 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPoolStatistics.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPoolStatistics.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 8188C617-4895-4B43-8D3B-FA6FC5B868DD online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Gets pool summary statistics for a Batch account. ## SYNTAX ``` -Get-AzureBatchPoolStatistics -BatchContext [] +Get-AzureBatchPoolStatistics -BatchContext [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -67,13 +69,27 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +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 ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPoolUsageMetrics.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPoolUsageMetrics.md index 0fe4d5fba9a2..ef242609e928 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPoolUsageMetrics.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchPoolUsageMetrics.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 4B373447-3078-4C1F-932E-8337AB170DEB online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets pool usage metrics for a Batch account. ``` Get-AzureBatchPoolUsageMetrics [-StartTime ] [-EndTime ] [-Filter ] - -BatchContext [] + -BatchContext [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -103,6 +104,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EndTime Specifies the end of a time range for which this cmdlet gets usage metrics. Specify a time at least two hours earlier. @@ -160,7 +176,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchRemoteDesktopProtocolFile.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchRemoteDesktopProtocolFile.md index 5fe4ab811c7a..2136b5978249 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchRemoteDesktopProtocolFile.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchRemoteDesktopProtocolFile.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: D077DB50-12BC-45AB-8EAC-57810DA83035 online version: schema: 2.0.0 @@ -15,25 +16,26 @@ Gets an RDP file from a compute node. ### Id_Path (Default) ``` Get-AzureBatchRemoteDesktopProtocolFile [-PoolId] [-ComputeNodeId] -DestinationPath - -BatchContext [] + -BatchContext [-DefaultProfile ] [] ``` ### Id_Stream ``` Get-AzureBatchRemoteDesktopProtocolFile [-PoolId] [-ComputeNodeId] - -DestinationStream -BatchContext [] + -DestinationStream -BatchContext [-DefaultProfile ] + [] ``` ### InputObject_Path ``` Get-AzureBatchRemoteDesktopProtocolFile [[-ComputeNode] ] -DestinationPath - -BatchContext [] + -BatchContext [-DefaultProfile ] [] ``` ### InputObject_Stream ``` Get-AzureBatchRemoteDesktopProtocolFile [[-ComputeNode] ] -DestinationStream - -BatchContext [] + -BatchContext [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -119,6 +121,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DestinationPath Specifies the file path where this cmdlet saves the .rdp file. @@ -171,11 +188,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### PSComputeNode - Parameter 'ComputeNode' accepts value of type 'PSComputeNode' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchRemoteLoginSettings.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchRemoteLoginSettings.md index bee20c04b2f3..460d3a715008 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchRemoteLoginSettings.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchRemoteLoginSettings.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 07811B64-6A77-452C-B148-DE8C13E73DEF online version: schema: 2.0.0 @@ -15,13 +16,13 @@ Gets remote logon settings for a compute node. ### Id (Default) ``` Get-AzureBatchRemoteLoginSettings [-PoolId] [-ComputeNodeId] - -BatchContext [] + -BatchContext [-DefaultProfile ] [] ``` ### InputObject ``` Get-AzureBatchRemoteLoginSettings [[-ComputeNode] ] -BatchContext - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -110,6 +111,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PoolId Specifies the ID of the pool that contains the virtual machine. @@ -131,11 +147,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### PSComputeNode - Parameter 'ComputeNode' accepts value of type 'PSComputeNode' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchSubtask.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchSubtask.md index 388e5983869c..4fe6c73aeeaa 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchSubtask.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchSubtask.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 7D0D8B46-4BF0-47D5-9261-3306AEB9E7DD online version: schema: 2.0.0 @@ -15,13 +16,13 @@ Gets the subtask information of the specified task. ### ODataFilter (Default) ``` Get-AzureBatchSubtask [-JobId] [-TaskId] [-MaxCount ] - -BatchContext [] + -BatchContext [-DefaultProfile ] [] ``` ### ParentObject ``` Get-AzureBatchSubtask [[-Task] ] [-MaxCount ] -BatchContext - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -60,6 +61,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -JobId Specifies the ID of the job that contains the task whose subtasks this cmdlet gets. @@ -129,11 +145,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### PSCloudTask - Parameter 'Task' accepts value of type 'PSCloudTask' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchTask.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchTask.md index df162a5c18f5..755fd133e7e2 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchTask.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureBatchTask.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 4B5FE41A-090B-4859-B021-05CF0A8B7882 online version: schema: 2.0.0 @@ -15,19 +16,21 @@ Gets the Batch tasks for a job. ### ODataFilter (Default) ``` Get-AzureBatchTask [-JobId] [-Filter ] [-MaxCount ] [-Select ] - [-Expand ] -BatchContext [] + [-Expand ] -BatchContext [-DefaultProfile ] + [] ``` ### Id ``` Get-AzureBatchTask [-JobId] [[-Id] ] [-Select ] [-Expand ] - -BatchContext [] + -BatchContext [-DefaultProfile ] [] ``` ### ParentObject ``` Get-AzureBatchTask [[-Job] ] [-Filter ] [-MaxCount ] [-Select ] - [-Expand ] -BatchContext [] + [-Expand ] -BatchContext [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -127,6 +130,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Expand Specifies an OData expand clause. Specify a value for this parameter to get associated entities of the main entity to get. @@ -245,11 +263,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### PSCloudJob - Parameter 'Job' accepts value of type 'PSCloudJob' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchAccount.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchAccount.md index c805ef823ca3..c5ed7068a437 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchAccount.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchAccount.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 818D5D85-B6D5-458C-A26E-E4DE8E111A10 -online version: +online version: schema: 2.0.0 --- @@ -14,7 +15,7 @@ Gets a Batch account in the current subscription. ``` Get-AzureRmBatchAccount [[-AccountName] ] [[-ResourceGroupName] ] [[-Tag] ] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -80,6 +81,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of a resource group. If you specify a resource group, this cmdlet gets the accounts under the specified resource group. @@ -87,7 +103,7 @@ If you specify a resource group, this cmdlet gets the accounts under the specifi ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 1 @@ -106,7 +122,7 @@ This cmdlet gets accounts that contain the tags that this parameter specifies. ```yaml Type: Hashtable Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 2 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchAccountKeys.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchAccountKeys.md index a1efeae96442..a31a8717c6b6 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchAccountKeys.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchAccountKeys.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: AFDE5ECD-29AB-4C91-98BF-1B8C9C3BB079 online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Gets the keys of a Batch account. ## SYNTAX ``` -Get-AzureRmBatchAccountKeys [-AccountName] [-ResourceGroupName ] [] +Get-AzureRmBatchAccountKeys [-AccountName] [-ResourceGroupName ] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -43,6 +45,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group that contains the account for which this cmdlet gets keys. diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchApplication.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchApplication.md index 0079dcac2e5c..8f66d36bfb69 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchApplication.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchApplication.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: CF8B8E94-3C6C-4D68-B55B-956393890946 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets information about the specified application. ``` Get-AzureRmBatchApplication [-AccountName] [-ResourceGroupName] [[-ApplicationId] ] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -66,6 +67,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group that contains the Batch account. diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchApplicationPackage.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchApplicationPackage.md index a1d26c5d5992..b28f2291b8ea 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchApplicationPackage.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchApplicationPackage.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 17653793-3CE1-465F-87F7-20B4B8F56193 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Gets information about an application package in a Batch account. ``` Get-AzureRmBatchApplicationPackage [-AccountName] [-ResourceGroupName] - [-ApplicationId] [-ApplicationVersion] [] + [-ApplicationId] [-ApplicationVersion] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -83,6 +85,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group that contains the Batch account. diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchLocationQuotas.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchLocationQuotas.md index ff49daf662de..c239fa1c91c7 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchLocationQuotas.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Get-AzureRmBatchLocationQuotas.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: A39A415A-B403-48D3-AF80-CF7CFE382577 online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Gets the Batch service quotas for your subscription at the given location. ## SYNTAX ``` -Get-AzureRmBatchLocationQuotas [-Location] [] +Get-AzureRmBatchLocationQuotas [-Location] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -34,6 +36,21 @@ The return value indicates that this subscription can create only one Batch acco ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Location Specifies the region for which this cmdlet checks the quotas. For more information, see Azure Regions (https://azure.microsoft.com/regions). diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchCertificate.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchCertificate.md index 7b2a1539bdb5..2f261b05d61a 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchCertificate.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchCertificate.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: B423C1A1-1988-4721-81E7-3B7EC163B03A online version: schema: 2.0.0 @@ -15,13 +16,13 @@ Adds a certificate to the specified Batch account. ### File (Default) ``` New-AzureBatchCertificate [-FilePath] [-Password ] -BatchContext - [] + [-DefaultProfile ] [] ``` ### RawData ``` New-AzureBatchCertificate [-RawData] [-Password ] -BatchContext - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -64,6 +65,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -FilePath Specifies the path of the certificate file. The certificate file must be in either .cer or .pfx format. @@ -117,11 +133,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### Byte[] - Parameter 'RawData' accepts value of type 'Byte[]' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchComputeNodeUser.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchComputeNodeUser.md index 105e2daaabdc..342c4e6ce21e 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchComputeNodeUser.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchComputeNodeUser.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: FE7689DE-4EC6-4C6B-94A4-D22C61CA569D online version: schema: 2.0.0 @@ -15,13 +16,15 @@ Creates a user account on a Batch compute node. ### Id ``` New-AzureBatchComputeNodeUser [-PoolId] [-ComputeNodeId] -Name -Password - [-ExpiryTime ] [-IsAdmin] -BatchContext [] + [-ExpiryTime ] [-IsAdmin] -BatchContext + [-DefaultProfile ] [] ``` ### ParentObject ``` New-AzureBatchComputeNodeUser [[-ComputeNode] ] -Name -Password - [-ExpiryTime ] [-IsAdmin] -BatchContext [] + [-ExpiryTime ] [-IsAdmin] -BatchContext + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -96,6 +99,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExpiryTime Specifies the expiry time for the new user account. @@ -177,11 +195,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### PSComputeNode - Parameter 'ComputeNode' accepts value of type 'PSComputeNode' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchJob.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchJob.md index 8af21e8c863d..cd8c140edb25 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchJob.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchJob.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: B6229D26-D38C-44CD-B9CA-7F39365C8B9D online version: schema: 2.0.0 @@ -18,7 +19,7 @@ New-AzureBatchJob [-Id] [-CommonEnvironmentSettings ] [-Di [-JobPreparationTask ] [-JobReleaseTask ] [-Metadata ] -PoolInformation [-Priority ] [-UsesTaskDependencies] [-OnTaskFailure ] [-OnAllTasksComplete ] - -BatchContext [] + -BatchContext [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -92,6 +93,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DisplayName Specifies the display name for the job. @@ -273,7 +289,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchJobSchedule.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchJobSchedule.md index de41576efd50..1686b04229ce 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchJobSchedule.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchJobSchedule.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 87E7FA51-427E-4DB8-A6A2-D8638FD3DB8B online version: schema: 2.0.0 @@ -15,7 +16,7 @@ Creates a job schedule in the Batch service. ``` New-AzureBatchJobSchedule [-Id] [-DisplayName ] -Schedule -JobSpecification [-Metadata ] -BatchContext - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -63,6 +64,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DisplayName Specifies a display name for the job schedule. @@ -146,7 +162,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchPool.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchPool.md index 3258c41384da..ca11ae5dea4e 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchPool.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchPool.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: C71C486E-34EB-42B5-B38A-D85B7DAA2F74 online version: schema: 2.0.0 @@ -21,7 +22,8 @@ New-AzureBatchPool [-Id] -VirtualMachineSize [-DisplayName ] [-ApplicationPackageReferences ] [-CloudServiceConfiguration ] [-NetworkConfiguration ] - -BatchContext [-WhatIf] [-Confirm] [] + -BatchContext [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### VirtualMachineAndTargetDedicated @@ -33,8 +35,8 @@ New-AzureBatchPool [-Id] -VirtualMachineSize [-DisplayName ] [-ApplicationPackageReferences ] [-VirtualMachineConfiguration ] - [-NetworkConfiguration ] -BatchContext [-WhatIf] [-Confirm] - [] + [-NetworkConfiguration ] -BatchContext + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### CloudServiceAndAutoScale @@ -46,7 +48,8 @@ New-AzureBatchPool [-Id] -VirtualMachineSize [-DisplayName ] [-ApplicationPackageReferences ] [-CloudServiceConfiguration ] [-NetworkConfiguration ] - -BatchContext [-WhatIf] [-Confirm] [] + -BatchContext [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### VirtualMachineAndAutoScale @@ -58,8 +61,8 @@ New-AzureBatchPool [-Id] -VirtualMachineSize [-DisplayName ] [-ApplicationPackageReferences ] [-VirtualMachineConfiguration ] - [-NetworkConfiguration ] -BatchContext [-WhatIf] [-Confirm] - [] + [-NetworkConfiguration ] -BatchContext + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -177,6 +180,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DisplayName Specifies the display name of the pool. @@ -396,7 +414,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchTask.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchTask.md index 1d1359b8b16b..d13f1c6f30a2 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchTask.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureBatchTask.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 2B4BFDDA-9721-42E6-84E1-A209CB782954 online version: schema: 2.0.0 @@ -19,19 +20,19 @@ New-AzureBatchTask -JobId -Id [-DisplayName ] [-Comman [-AffinityInformation ] [-Constraints ] [-MultiInstanceSettings ] [-DependsOn ] [-ApplicationPackageReferences ] [-ExitConditions ] - -BatchContext [] + -BatchContext [-DefaultProfile ] [] ``` ### JobId_Bulk ``` New-AzureBatchTask -JobId [-Tasks ] -BatchContext - [] + [-DefaultProfile ] [] ``` ### JobObject_Bulk ``` New-AzureBatchTask [-Job ] [-Tasks ] -BatchContext - [] + [-DefaultProfile ] [] ``` ### JobObject_Single @@ -41,7 +42,7 @@ New-AzureBatchTask [-Job ] -Id [-DisplayName ] [-Co [-AffinityInformation ] [-Constraints ] [-MultiInstanceSettings ] [-DependsOn ] [-ApplicationPackageReferences ] [-ExitConditions ] - -BatchContext [] + -BatchContext [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -179,6 +180,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DependsOn Specifies that the task depends on other tasks. The task will not be scheduled until all depended-on tasks have completed successfully. @@ -355,11 +371,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### PSCloudJob - Parameter 'Job' accepts value of type 'PSCloudJob' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchAccount.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchAccount.md index 43606acadbb9..6a19e4e92cd6 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchAccount.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchAccount.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 82C7B128-8818-4390-B1A5-CB40AC9D53CA -online version: +online version: schema: 2.0.0 --- @@ -14,7 +15,8 @@ Creates a Batch account. ``` New-AzureRmBatchAccount [-AccountName] [-Location] [-ResourceGroupName] - [[-AutoStorageAccountId] ] [-Tag ] [] + [[-AutoStorageAccountId] ] [-Tag ] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -62,7 +64,7 @@ Specifies the resource ID of the storage account to be used for auto storage. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: 3 @@ -71,6 +73,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Location Specifies the region where this cmdlet creates the account. For more information, see [Azure Regions](https://azure.microsoft.com/en-us/regions). @@ -78,7 +95,7 @@ For more information, see [Azure Regions](https://azure.microsoft.com/en-us/regi ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -93,7 +110,7 @@ Specifies the name of the resource group in which this cmdlet creates the accoun ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 2 diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchAccountKey.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchAccountKey.md index 1abebfa17d17..a9990c244e8c 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchAccountKey.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchAccountKey.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 486748AC-3932-4E0C-BBCC-2BC194E69DCC online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Regenerates a key of a Batch account. ``` New-AzureRmBatchAccountKey [-AccountName] [-ResourceGroupName ] -KeyType - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -61,6 +62,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -KeyType Specifies the type of key that this cmdlet regenerates. Valid values are: diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchApplication.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchApplication.md index b564e1a3303f..9364328f2d18 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchApplication.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchApplication.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: FF111B74-90A3-4F7C-B515-CE1EEF68EB54 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Adds an application to the specified Batch account. ``` New-AzureRmBatchApplication [-AccountName] [-ResourceGroupName] [-ApplicationId] - [[-AllowUpdates] ] [[-DisplayName] ] [] + [[-AllowUpdates] ] [[-DisplayName] ] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -77,6 +79,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DisplayName Specifies the display name for the application. diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchApplicationPackage.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchApplicationPackage.md index d562e2ba0c13..7d274b2d5466 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchApplicationPackage.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/New-AzureRmBatchApplicationPackage.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: D53DAEB6-DC4F-473C-A193-A1E2A65326D4 online version: schema: 2.0.0 @@ -16,14 +17,14 @@ Creates an application package in a Batch account. ``` New-AzureRmBatchApplicationPackage [-AccountName] [-ResourceGroupName] [-ApplicationId] [-ApplicationVersion] [-Format] -FilePath - [] + [-DefaultProfile ] [] ``` ### ActivateOnly ``` New-AzureRmBatchApplicationPackage [-AccountName] [-ResourceGroupName] [-ApplicationId] [-ApplicationVersion] [-Format] [-ActivateOnly] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -100,6 +101,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -FilePath Specifies the file to be uploaded as the application package binary file. diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchCertificate.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchCertificate.md index a435a204f546..503c02ae1ed5 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchCertificate.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchCertificate.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 3DFFD0F2-6CD8-4FBE-B15C-8505CBF8F44E online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Deletes a certificate from an account. ``` Remove-AzureBatchCertificate [-ThumbprintAlgorithm] [-Thumbprint] - -BatchContext [-WhatIf] [-Confirm] [] + -BatchContext [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -58,6 +60,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Thumbprint Specifies the thumbprint of the certificate that this cmdlet deletes. @@ -126,7 +143,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchComputeNode.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchComputeNode.md index 7b0462e092de..3d20a628e366 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchComputeNode.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchComputeNode.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 0BB79553-26DA-413C-8086-740DB6B31A85 online version: schema: 2.0.0 @@ -16,14 +17,16 @@ Removes compute nodes from a pool. ``` Remove-AzureBatchComputeNode [-PoolId] [-Ids] [-DeallocationOption ] [-ResizeTimeout ] [-Force] - -BatchContext [-WhatIf] [-Confirm] [] + -BatchContext [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### InputObject ``` Remove-AzureBatchComputeNode [[-ComputeNode] ] [-DeallocationOption ] [-ResizeTimeout ] [-Force] - -BatchContext [-WhatIf] [-Confirm] [] + -BatchContext [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -109,6 +112,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. @@ -208,11 +226,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### PSComputeNode - Parameter 'ComputeNode' accepts value of type 'PSComputeNode' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchComputeNodeUser.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchComputeNodeUser.md index 9d2697a058ba..424a3228f742 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchComputeNodeUser.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchComputeNodeUser.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 9E423A10-06AF-42F8-AC90-82DB01012AFA online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Deletes a user account from a Batch compute node. ``` Remove-AzureBatchComputeNodeUser [-PoolId] [-ComputeNodeId] [-Name] - -BatchContext [-WhatIf] [-Confirm] [] + -BatchContext [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -65,6 +67,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the name of the user account to delete. You cannot specify wildcard characters. @@ -133,7 +150,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchJob.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchJob.md index 165f3c1d6387..23f11c3c797f 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchJob.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchJob.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: CB2F472B-C792-4A11-A055-F4161DCFBB28 online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Deletes a Batch job. ## SYNTAX ``` -Remove-AzureBatchJob [-Id] [-Force] -BatchContext [-WhatIf] [-Confirm] - [] +Remove-AzureBatchJob [-Id] [-Force] -BatchContext + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -60,6 +61,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. @@ -128,7 +144,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchJobSchedule.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchJobSchedule.md index 46a8697fc202..38e30aef32f6 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchJobSchedule.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchJobSchedule.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 97FA5983-0D73-4336-99DA-46E5992F06DC online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Removes a Batch job schedule. ## SYNTAX ``` -Remove-AzureBatchJobSchedule [-Id] [-Force] -BatchContext [-WhatIf] [-Confirm] - [] +Remove-AzureBatchJobSchedule [-Id] [-Force] -BatchContext + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,6 +46,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. @@ -112,7 +128,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchNodeFile.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchNodeFile.md index 807d8357e82d..389994641de8 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchNodeFile.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchNodeFile.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: DBA02017-8372-4A91-A4F1-985777DEDAB9 online version: schema: 2.0.0 @@ -15,19 +16,22 @@ Deletes a node file for a task or compute node. ### Task ``` Remove-AzureBatchNodeFile -JobId -TaskId -Name [-Force] [-Recursive] - -BatchContext [-WhatIf] [-Confirm] [] + -BatchContext [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### ComputeNode ``` Remove-AzureBatchNodeFile [-PoolId] [-ComputeNodeId] -Name [-Force] [-Recursive] - -BatchContext [-WhatIf] [-Confirm] [] + -BatchContext [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### InputObject ``` Remove-AzureBatchNodeFile [[-InputObject] ] [-Force] [-Recursive] - -BatchContext [-WhatIf] [-Confirm] [] + -BatchContext [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -95,6 +99,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. @@ -239,11 +258,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### PSNodeFile - Parameter 'InputObject' accepts value of type 'PSNodeFile' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchPool.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchPool.md index 1dd7f22b33d7..2aaddec2c7f4 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchPool.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchPool.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: DB0A8E4B-AD3F-4BAC-A0B2-031913E019D4 online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Deletes the specified Batch pool. ## SYNTAX ``` -Remove-AzureBatchPool [-Id] [-Force] -BatchContext [-WhatIf] [-Confirm] - [] +Remove-AzureBatchPool [-Id] [-Force] -BatchContext + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -57,6 +58,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. @@ -125,7 +141,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchTask.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchTask.md index dd150124f7f1..43456be0cf88 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchTask.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureBatchTask.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: D79AEF8C-F0DC-40F8-9EEE-A2BB6AE5C4BF online version: schema: 2.0.0 @@ -14,14 +15,14 @@ Deletes a Batch task. ### Id ``` -Remove-AzureBatchTask [-JobId] [-Id] [-Force] -BatchContext [-WhatIf] - [-Confirm] [] +Remove-AzureBatchTask [-JobId] [-Id] [-Force] -BatchContext + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### InputObject ``` -Remove-AzureBatchTask [-InputObject] [-Force] -BatchContext [-WhatIf] - [-Confirm] [] +Remove-AzureBatchTask [-InputObject] [-Force] -BatchContext + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -68,6 +69,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. @@ -167,11 +183,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### PSCloudTask - Parameter 'InputObject' accepts value of type 'PSCloudTask' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureRmBatchAccount.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureRmBatchAccount.md index c69bb0df3f4c..ddf984babc06 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureRmBatchAccount.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureRmBatchAccount.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 89F604DD-EE77-440D-BCC9-3F74D994C447 online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Removes a Batch account. ## SYNTAX ``` -Remove-AzureRmBatchAccount [-AccountName] [[-ResourceGroupName] ] [-Force] [-WhatIf] - [-Confirm] [] +Remove-AzureRmBatchAccount [-AccountName] [[-ResourceGroupName] ] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -48,6 +49,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureRmBatchApplication.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureRmBatchApplication.md index a973c733955e..6bb977e7f018 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureRmBatchApplication.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureRmBatchApplication.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 2CED21D6-4BEF-423B-A04A-5B812CEB975D online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Deletes an application from a Batch account. ``` Remove-AzureRmBatchApplication [-AccountName] [-ResourceGroupName] [-ApplicationId] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -62,6 +63,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group that contains the Batch account. diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureRmBatchApplicationPackage.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureRmBatchApplicationPackage.md index cddbfb678ae5..3c5039fece02 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureRmBatchApplicationPackage.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Remove-AzureRmBatchApplicationPackage.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: FD2E3442-9CEA-4390-BE9C-772C7D6FD1E2 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Deletes an application package record and the binary file. ``` Remove-AzureRmBatchApplicationPackage [-AccountName] [-ResourceGroupName] - [-ApplicationId] [-ApplicationVersion] [] + [-ApplicationId] [-ApplicationVersion] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -77,6 +79,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group that contains the Batch account. diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Reset-AzureBatchComputeNode.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Reset-AzureBatchComputeNode.md index 803b4816e289..f17fe73e00e7 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Reset-AzureBatchComputeNode.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Reset-AzureBatchComputeNode.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: A202537B-D292-4822-A0B9-27A6A20621D4 online version: schema: 2.0.0 @@ -15,13 +16,13 @@ Reinstalls the operating system on the specified compute node. ### Id (Default) ``` Reset-AzureBatchComputeNode [-PoolId] [-Id] [-ReimageOption ] - -BatchContext [] + -BatchContext [-DefaultProfile ] [] ``` ### InputObject ``` Reset-AzureBatchComputeNode [[-ComputeNode] ] [-ReimageOption ] - -BatchContext [] + -BatchContext [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -77,6 +78,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id Specifies the ID of the compute node to reimage. @@ -130,11 +146,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### PSComputeNode - Parameter 'ComputeNode' accepts value of type 'PSComputeNode' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Restart-AzureBatchComputeNode.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Restart-AzureBatchComputeNode.md index d365b65dd812..5aa88bb2edb9 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Restart-AzureBatchComputeNode.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Restart-AzureBatchComputeNode.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 029361F0-C4E9-4948-9EBA-BFBD1B029909 online version: schema: 2.0.0 @@ -15,13 +16,13 @@ Reboots the specified compute node. ### Id (Default) ``` Restart-AzureBatchComputeNode [-PoolId] [-Id] [[-RebootOption] ] - -BatchContext [] + -BatchContext [-DefaultProfile ] [] ``` ### InputObject ``` Restart-AzureBatchComputeNode [[-ComputeNode] ] [[-RebootOption] ] - -BatchContext [] + -BatchContext [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -76,6 +77,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id Specifies the ID of the compute node to reboot. @@ -129,11 +145,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### PSComputeNode - Parameter 'ComputeNode' accepts value of type 'PSComputeNode' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchComputeNodeUser.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchComputeNodeUser.md index 82e7cd2ff679..b4e6b1d7f141 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchComputeNodeUser.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchComputeNodeUser.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: A0D620DA-B5A3-4F8F-BD43-A58630C95432 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Modifies properties of an account on a Batch compute node. ``` Set-AzureBatchComputeNodeUser [-PoolId] [-ComputeNodeId] [-Name] - [-Password] [-ExpiryTime ] -BatchContext [] + [-Password] [-ExpiryTime ] -BatchContext + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -63,6 +65,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExpiryTime Specifies the expiry time for the user account. @@ -129,7 +146,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchJob.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchJob.md index 535b0dd010c2..c5eb4fc83622 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchJob.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchJob.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 75483BC7-440A-437B-9EDE-D270D87CF3C5 online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Updates a Batch job. ## SYNTAX ``` -Set-AzureBatchJob [-Job] -BatchContext [] +Set-AzureBatchJob [-Job] -BatchContext + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -54,6 +56,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Job Specifies a **PSCloudJob** to which this cmdlet updates the Batch service. @@ -75,11 +92,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### PSCloudJob - Parameter 'Job' accepts value of type 'PSCloudJob' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchJobSchedule.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchJobSchedule.md index 9279499d9eaf..fcc3fc908dd1 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchJobSchedule.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchJobSchedule.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 14026F0E-4959-4150-A31F-A94BC56ED808 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Sets a job schedule. ``` Set-AzureBatchJobSchedule [-JobSchedule] -BatchContext - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -45,6 +46,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -JobSchedule Specifies a **PSCloudJobSchedule** object that represents a job schedule. To obtain a **PSCloudJobSchedule** object, use the Get-AzureBatchJobSchedule cmdlet. @@ -67,11 +83,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### PSCloudJobSchedule - Parameter 'JobSchedule' accepts value of type 'PSCloudJobSchedule' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchPool.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchPool.md index 7d468714a5b0..2c2c3a7abd96 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchPool.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchPool.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 23893EAE-47F3-45AA-AEB2-354FB8316C25 online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Updates the properties of a pool. ## SYNTAX ``` -Set-AzureBatchPool [-Pool] -BatchContext [] +Set-AzureBatchPool [-Pool] -BatchContext + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -56,6 +58,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Pool Specifies the **PSCloudPool** to which this cmdlet updates the Batch service. @@ -77,11 +94,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### PSCloudPool - Parameter 'Pool' accepts value of type 'PSCloudPool' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchPoolOSVersion.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchPoolOSVersion.md index 7b829d06cfe8..a3927c041923 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchPoolOSVersion.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchPoolOSVersion.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 4C3C6C81-7486-4ED6-BA30-2F202E654F77 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Changes the operating system version of the specified pool. ``` Set-AzureBatchPoolOSVersion [-Id] [-TargetOSVersion] -BatchContext - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -47,6 +48,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id Specifies the ID of the pool. @@ -84,11 +100,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### String - Parameter 'Id' accepts value of type 'String' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchTask.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchTask.md index 523065160586..599abc02c37a 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchTask.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureBatchTask.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 6A6D6C7D-EED7-4AD4-ACE6-BFA64404455E online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Updates the properties of a task. ## SYNTAX ``` -Set-AzureBatchTask [-Task] -BatchContext [] +Set-AzureBatchTask [-Task] -BatchContext + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -55,6 +57,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Task Specifies the **PSCloudTask** to which this cmdlet updates the Batch service. @@ -76,11 +93,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### PSCloudTask - Parameter 'Task' accepts value of type 'PSCloudTask' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureRmBatchAccount.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureRmBatchAccount.md index dff618f34da5..54b9e9bddbee 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureRmBatchAccount.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureRmBatchAccount.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 9BEE5888-304D-4438-BE97-D1FE254AEE98 -online version: +online version: schema: 2.0.0 --- @@ -14,7 +15,7 @@ Updates a Batch account. ``` Set-AzureRmBatchAccount [-AccountName] [-Tag] [-ResourceGroupName ] - [-AutoStorageAccountId ] [] + [-AutoStorageAccountId ] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -66,7 +67,7 @@ Specifies the resource ID of the storage account to be used for auto storage. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -75,13 +76,28 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the resource group of the account that this cmdlet updates. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureRmBatchApplication.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureRmBatchApplication.md index 453801f7949b..09433c16568e 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureRmBatchApplication.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Set-AzureRmBatchApplication.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: DCA1FD7A-54AF-48B1-A245-BFA9C43ACA9B online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Updates settings for the specified application. ``` Set-AzureRmBatchApplication [-AccountName] [-ResourceGroupName] [-ApplicationId] - [[-DisplayName] ] [[-DefaultVersion] ] [[-AllowUpdates] ] [] + [[-DisplayName] ] [[-DefaultVersion] ] [[-AllowUpdates] ] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -77,6 +79,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DefaultVersion Specifies which package to use if a client requests the application but does not specify a version. diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Start-AzureBatchPoolResize.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Start-AzureBatchPoolResize.md index e619cb9b0fa6..d48afc081b69 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Start-AzureBatchPoolResize.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Start-AzureBatchPoolResize.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 82DC8DC4-D8EC-4847-A54C-B779256FD590 online version: schema: 2.0.0 @@ -15,7 +16,7 @@ Starts to resize a pool. ``` Start-AzureBatchPoolResize [-Id] -TargetDedicated [-ResizeTimeout ] [-ComputeNodeDeallocationOption ] -BatchContext - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -79,6 +80,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id Specifies the ID of the pool that this cmdlet resizes. @@ -131,11 +147,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### String - Parameter 'Id' accepts value of type 'String' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchCertificateDeletion.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchCertificateDeletion.md index c1743324fdd2..099ecacf716a 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchCertificateDeletion.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchCertificateDeletion.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: B3C8A2DB-6571-418D-8C4B-3BE3FDA42F89 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Cancels a failed deletion of a certificate. ``` Stop-AzureBatchCertificateDeletion [-ThumbprintAlgorithm] [-Thumbprint] - -BatchContext [] + -BatchContext [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -49,6 +50,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Thumbprint Specifies the thumbprint of the certificate that this cmdlet restores to the **Active** state. @@ -86,7 +102,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchJob.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchJob.md index 58c0e3b9de8d..d56e6b7dae46 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchJob.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchJob.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 975B707C-5001-43ED-81AB-9BB6665135BA online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Stops a Batch job. ``` Stop-AzureBatchJob [-Id] [[-TerminateReason] ] -BatchContext - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -50,6 +51,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id Specifies the ID of the job that this cmdlet stops. @@ -87,11 +103,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### String - Parameter 'Id' accepts value of type 'String' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchJobSchedule.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchJobSchedule.md index 1c40c2938638..68e68c950ce7 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchJobSchedule.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchJobSchedule.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: D1C5B35C-5419-4739-9D57-6C4228E98DAC online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Stops a Batch job schedule. ## SYNTAX ``` -Stop-AzureBatchJobSchedule [-Id] -BatchContext [] +Stop-AzureBatchJobSchedule [-Id] -BatchContext + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -47,6 +49,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id Specifies the ID of the job schedule that this cmdlet stops. @@ -68,11 +85,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### String - Parameter 'Id' accepts value of type 'String' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchPoolResize.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchPoolResize.md index cccfa49927b5..feebabb77428 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchPoolResize.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchPoolResize.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 3E736E85-0488-4D10-BEA1-4F9B8DA54C4B online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Stops a pool resize operation. ## SYNTAX ``` -Stop-AzureBatchPoolResize [-Id] -BatchContext [] +Stop-AzureBatchPoolResize [-Id] -BatchContext + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -57,6 +59,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id Specifies the ID of the pool for which this cmdlet stops a resizing operation. @@ -78,11 +95,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### String - Parameter 'Id' accepts value of type 'String' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchTask.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchTask.md index 22ae4ed8250e..5767340d9621 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchTask.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Stop-AzureBatchTask.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: 1EA57372-6FA5-45C9-94A1-50D53830FC10 online version: schema: 2.0.0 @@ -14,12 +15,14 @@ Stops a Batch task. ### Id ``` -Stop-AzureBatchTask [-JobId] [-Id] -BatchContext [] +Stop-AzureBatchTask [-JobId] [-Id] -BatchContext + [-DefaultProfile ] [] ``` ### InputObject ``` -Stop-AzureBatchTask [-Task] -BatchContext [] +Stop-AzureBatchTask [-Task] -BatchContext + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -63,6 +66,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id Specifies the ID of the task that this cmdlet stops. @@ -115,11 +133,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### PSCloudTask - Parameter 'Task' accepts value of type 'PSCloudTask' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/AzureBatch/Commands.Batch/help/Test-AzureBatchAutoScale.md b/src/ResourceManager/AzureBatch/Commands.Batch/help/Test-AzureBatchAutoScale.md index 28bb53670093..7a83c998514e 100644 --- a/src/ResourceManager/AzureBatch/Commands.Batch/help/Test-AzureBatchAutoScale.md +++ b/src/ResourceManager/AzureBatch/Commands.Batch/help/Test-AzureBatchAutoScale.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Batch.dll-Help.xml +Module Name: AzureRM.Batch ms.assetid: BF0C1A2F-2703-492F-A3A7-053416A5D1EB online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets the result of an automatic scaling formula on a pool. ``` Test-AzureBatchAutoScale [-Id] [-AutoScaleFormula] -BatchContext - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -69,6 +70,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id Specifies the object ID of the pool for which to test automatic scaling. @@ -90,11 +106,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### BatchAccountContext - Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline ### String - Parameter 'Id' accepts value of type 'String' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/Profile/Commands.Profile/help/Add-AzureRmAccount.md b/src/ResourceManager/Profile/Commands.Profile/help/Add-AzureRmAccount.md index 6e2a161de7a8..b2009603e814 100644 --- a/src/ResourceManager/Profile/Commands.Profile/help/Add-AzureRmAccount.md +++ b/src/ResourceManager/Profile/Commands.Profile/help/Add-AzureRmAccount.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml +Module Name: AzureRM.Profile online version: schema: 2.0.0 --- diff --git a/src/ResourceManager/Profile/Commands.Profile/help/Add-AzureRmEnvironment.md b/src/ResourceManager/Profile/Commands.Profile/help/Add-AzureRmEnvironment.md index fcbb9eb1f9b5..58fb2b759cd6 100644 --- a/src/ResourceManager/Profile/Commands.Profile/help/Add-AzureRmEnvironment.md +++ b/src/ResourceManager/Profile/Commands.Profile/help/Add-AzureRmEnvironment.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml +Module Name: AzureRM.Profile online version: schema: 2.0.0 --- @@ -29,8 +30,9 @@ Add-AzureRmEnvironment [-Name] [[-PublishSettingsFileUrl] ] [[- ### ARMEndpoint ``` Add-AzureRmEnvironment [-Name] [[-StorageEndpoint] ] [-ARMEndpoint] - [[-AzureKeyVaultDnsSuffix] ] [[-DataLakeAudience] ] [-Scope ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [[-AzureKeyVaultDnsSuffix] ] [[-AzureKeyVaultServiceEndpointResourceId] ] + [[-DataLakeAudience] ] [-Scope ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -208,7 +210,7 @@ Specifies the audience for access tokens that authorize requests for Key Vault s ```yaml Type: String -Parameter Sets: Name +Parameter Sets: (All) Aliases: Required: False diff --git a/src/ResourceManager/Profile/Commands.Profile/help/AzureRM.Profile.md b/src/ResourceManager/Profile/Commands.Profile/help/AzureRM.Profile.md index 4fa81fbd967a..a9b47666670c 100644 --- a/src/ResourceManager/Profile/Commands.Profile/help/AzureRM.Profile.md +++ b/src/ResourceManager/Profile/Commands.Profile/help/AzureRM.Profile.md @@ -40,7 +40,7 @@ Gets the metadata used to authenticate Azure Resource Manager requests. ### [Get-AzureRmContextAutosaveSetting](Get-AzureRmContextAutosaveSetting.md) Display metadata about the context autosave feature, including whterh the context is -automatically saved, and where saved context and credential information can be found. +automaticallys aved, and where saved context and credential information cna be found. ### [Get-AzureRmEnvironment](Get-AzureRmEnvironment.md) Get endpoints and metadata for an instance of Azure services. @@ -55,7 +55,7 @@ Gets tenants that are authorized for the current user. Loads Azure authentication information from a file. ### [Remove-AzureRmAccount](Remove-AzureRmAccount.md) -Remove all credentials and contexts associated with this account. +Remove all credentials and contexts associated with the given account. ### [Remove-AzureRmContext](Remove-AzureRmContext.md) Remove a context from the set of available contexts @@ -73,7 +73,7 @@ Display detailed information about PowerShell errors, with extended details for Saves the current authentication information for use in other PowerShell sessions. ### [Select-AzureRmContext](Select-AzureRmContext.md) -Select a subscription to target (or account, tenant) in Azure PowerShell cmdlets +Select a subscription and account to target in Azure PowerShell cmdlets ### [Send-Feedback](Send-Feedback.md) Sends feedback to the Azure PowerShell team via a set of guided prompts. diff --git a/src/ResourceManager/Profile/Commands.Profile/help/Clear-AzureRmContext.md b/src/ResourceManager/Profile/Commands.Profile/help/Clear-AzureRmContext.md index e6c6ea525730..ce193b5f6efd 100644 --- a/src/ResourceManager/Profile/Commands.Profile/help/Clear-AzureRmContext.md +++ b/src/ResourceManager/Profile/Commands.Profile/help/Clear-AzureRmContext.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml +Module Name: AzureRM.Profile online version: schema: 2.0.0 --- diff --git a/src/ResourceManager/Profile/Commands.Profile/help/Disable-AzureRmContextAutosave.md b/src/ResourceManager/Profile/Commands.Profile/help/Disable-AzureRmContextAutosave.md index a3a2cefb5cf9..a348b42a4f54 100644 --- a/src/ResourceManager/Profile/Commands.Profile/help/Disable-AzureRmContextAutosave.md +++ b/src/ResourceManager/Profile/Commands.Profile/help/Disable-AzureRmContextAutosave.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml +Module Name: AzureRM.Profile online version: schema: 2.0.0 --- diff --git a/src/ResourceManager/Profile/Commands.Profile/help/Disable-AzureRmDataCollection.md b/src/ResourceManager/Profile/Commands.Profile/help/Disable-AzureRmDataCollection.md index 15479a94b22b..0d0a3ef81d9b 100644 --- a/src/ResourceManager/Profile/Commands.Profile/help/Disable-AzureRmDataCollection.md +++ b/src/ResourceManager/Profile/Commands.Profile/help/Disable-AzureRmDataCollection.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml +Module Name: AzureRM.Profile online version: schema: 2.0.0 --- diff --git a/src/ResourceManager/Profile/Commands.Profile/help/Enable-AzureRmContextAutosave.md b/src/ResourceManager/Profile/Commands.Profile/help/Enable-AzureRmContextAutosave.md index 4c0e05cc5ac6..719000e17d09 100644 --- a/src/ResourceManager/Profile/Commands.Profile/help/Enable-AzureRmContextAutosave.md +++ b/src/ResourceManager/Profile/Commands.Profile/help/Enable-AzureRmContextAutosave.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml +Module Name: AzureRM.Profile online version: schema: 2.0.0 --- diff --git a/src/ResourceManager/Profile/Commands.Profile/help/Enable-AzureRmDataCollection.md b/src/ResourceManager/Profile/Commands.Profile/help/Enable-AzureRmDataCollection.md index 95dabd60753a..ba278266beed 100644 --- a/src/ResourceManager/Profile/Commands.Profile/help/Enable-AzureRmDataCollection.md +++ b/src/ResourceManager/Profile/Commands.Profile/help/Enable-AzureRmDataCollection.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml +Module Name: AzureRM.Profile online version: schema: 2.0.0 --- diff --git a/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmContext.md b/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmContext.md index a1d179ae5c1d..875bb240e175 100644 --- a/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmContext.md +++ b/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmContext.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml +Module Name: AzureRM.Profile online version: schema: 2.0.0 --- @@ -44,7 +45,6 @@ CurrentStorageAccount : In this example we are logging into our account with an Azure subscription using Add-AzureRmAccount, and then we are getting the context of the current session by calling Get-AzureRmContext. - ### Example 2: Listing all available contexts ``` PS C:\> Get-AzureRmContext -ListAvailable @@ -107,6 +107,7 @@ The name of the context Type: String Parameter Sets: GetSingleContext Aliases: +Accepted values: Default Required: False Position: 0 diff --git a/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmContextAutosaveSetting.md b/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmContextAutosaveSetting.md index 847962a19b81..53b9786bec37 100644 --- a/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmContextAutosaveSetting.md +++ b/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmContextAutosaveSetting.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml +Module Name: AzureRM.Profile online version: schema: 2.0.0 --- diff --git a/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmEnvironment.md b/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmEnvironment.md index f7046baa526e..a5bbbf50fb2d 100644 --- a/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmEnvironment.md +++ b/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmEnvironment.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml +Module Name: AzureRM.Profile online version: schema: 2.0.0 --- diff --git a/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmSubscription.md b/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmSubscription.md index 07221b92b625..ab67359a7d69 100644 --- a/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmSubscription.md +++ b/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmSubscription.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml +Module Name: AzureRM.Profile online version: schema: 2.0.0 --- diff --git a/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmTenant.md b/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmTenant.md index 1417af64f670..ad33aec3ffe8 100644 --- a/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmTenant.md +++ b/src/ResourceManager/Profile/Commands.Profile/help/Get-AzureRmTenant.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml +Module Name: AzureRM.Profile online version: schema: 2.0.0 --- diff --git a/src/ResourceManager/Profile/Commands.Profile/help/Import-AzureRmContext.md b/src/ResourceManager/Profile/Commands.Profile/help/Import-AzureRmContext.md index 1446919c01d0..fb0d260ef232 100644 --- a/src/ResourceManager/Profile/Commands.Profile/help/Import-AzureRmContext.md +++ b/src/ResourceManager/Profile/Commands.Profile/help/Import-AzureRmContext.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml +Module Name: AzureRM.Profile online version: schema: 2.0.0 --- @@ -11,15 +12,15 @@ Loads Azure authentication information from a file. ## SYNTAX -### InMemoryProfile +### ProfileFromDisk (Default) ``` -Import-AzureRmContext [-AzureContext] [-Scope ] +Import-AzureRmContext [-Path] [-Scope ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` -### ProfileFromDisk +### InMemoryProfile ``` -Import-AzureRmContext [-Path] [-Scope ] +Import-AzureRmContext [-AzureContext] [-Scope ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` diff --git a/src/ResourceManager/Profile/Commands.Profile/help/Remove-AzureRmAccount.md b/src/ResourceManager/Profile/Commands.Profile/help/Remove-AzureRmAccount.md index c43d60e4c88f..f65d18caf25d 100644 --- a/src/ResourceManager/Profile/Commands.Profile/help/Remove-AzureRmAccount.md +++ b/src/ResourceManager/Profile/Commands.Profile/help/Remove-AzureRmAccount.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml +Module Name: AzureRM.Profile online version: schema: 2.0.0 --- diff --git a/src/ResourceManager/Profile/Commands.Profile/help/Remove-AzureRmContext.md b/src/ResourceManager/Profile/Commands.Profile/help/Remove-AzureRmContext.md index e759bf7697d3..f83ee9748b28 100644 --- a/src/ResourceManager/Profile/Commands.Profile/help/Remove-AzureRmContext.md +++ b/src/ResourceManager/Profile/Commands.Profile/help/Remove-AzureRmContext.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml +Module Name: AzureRM.Profile online version: schema: 2.0.0 --- @@ -89,6 +90,7 @@ The name of the context Type: String Parameter Sets: Named Context Aliases: +Accepted values: Default Required: True Position: 0 diff --git a/src/ResourceManager/Profile/Commands.Profile/help/Remove-AzureRmEnvironment.md b/src/ResourceManager/Profile/Commands.Profile/help/Remove-AzureRmEnvironment.md index 44c7bfa7a063..7ffa1d1d4090 100644 --- a/src/ResourceManager/Profile/Commands.Profile/help/Remove-AzureRmEnvironment.md +++ b/src/ResourceManager/Profile/Commands.Profile/help/Remove-AzureRmEnvironment.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml +Module Name: AzureRM.Profile online version: schema: 2.0.0 --- diff --git a/src/ResourceManager/Profile/Commands.Profile/help/Rename-AzureRmContext.md b/src/ResourceManager/Profile/Commands.Profile/help/Rename-AzureRmContext.md index cbcb78df636a..70270281bca9 100644 --- a/src/ResourceManager/Profile/Commands.Profile/help/Rename-AzureRmContext.md +++ b/src/ResourceManager/Profile/Commands.Profile/help/Rename-AzureRmContext.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml +Module Name: AzureRM.Profile online version: schema: 2.0.0 --- @@ -130,6 +131,7 @@ The name of the context Type: String Parameter Sets: Context Name Aliases: +Accepted values: Default Required: True Position: 0 diff --git a/src/ResourceManager/Profile/Commands.Profile/help/Resolve-AzureRmError.md b/src/ResourceManager/Profile/Commands.Profile/help/Resolve-AzureRmError.md index b52e2f9b9935..84a8c9211073 100644 --- a/src/ResourceManager/Profile/Commands.Profile/help/Resolve-AzureRmError.md +++ b/src/ResourceManager/Profile/Commands.Profile/help/Resolve-AzureRmError.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml +Module Name: AzureRM.Profile online version: schema: 2.0.0 --- diff --git a/src/ResourceManager/Profile/Commands.Profile/help/Save-AzureRmContext.md b/src/ResourceManager/Profile/Commands.Profile/help/Save-AzureRmContext.md index 36fedde784a8..20a0691578b8 100644 --- a/src/ResourceManager/Profile/Commands.Profile/help/Save-AzureRmContext.md +++ b/src/ResourceManager/Profile/Commands.Profile/help/Save-AzureRmContext.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml +Module Name: AzureRM.Profile online version: schema: 2.0.0 --- diff --git a/src/ResourceManager/Profile/Commands.Profile/help/Select-AzureRmContext.md b/src/ResourceManager/Profile/Commands.Profile/help/Select-AzureRmContext.md index 3e65c752da65..5e35b1c88298 100644 --- a/src/ResourceManager/Profile/Commands.Profile/help/Select-AzureRmContext.md +++ b/src/ResourceManager/Profile/Commands.Profile/help/Select-AzureRmContext.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml +Module Name: AzureRM.Profile online version: schema: 2.0.0 --- @@ -75,6 +76,7 @@ The name of the context Type: String Parameter Sets: Context Name Aliases: +Accepted values: Default Required: True Position: 0 diff --git a/src/ResourceManager/Profile/Commands.Profile/help/Send-Feedback.md b/src/ResourceManager/Profile/Commands.Profile/help/Send-Feedback.md index 2b9c39cbd3cc..bfeadb9130d8 100644 --- a/src/ResourceManager/Profile/Commands.Profile/help/Send-Feedback.md +++ b/src/ResourceManager/Profile/Commands.Profile/help/Send-Feedback.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml +Module Name: AzureRM.Profile online version: schema: 2.0.0 --- diff --git a/src/ResourceManager/Profile/Commands.Profile/help/Set-AzureRmContext.md b/src/ResourceManager/Profile/Commands.Profile/help/Set-AzureRmContext.md index 72ada4877567..6ab89d79fcd3 100644 --- a/src/ResourceManager/Profile/Commands.Profile/help/Set-AzureRmContext.md +++ b/src/ResourceManager/Profile/Commands.Profile/help/Set-AzureRmContext.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml +Module Name: AzureRM.Profile online version: schema: 2.0.0 --- diff --git a/src/ResourceManager/Profile/Commands.Profile/help/Set-AzureRmEnvironment.md b/src/ResourceManager/Profile/Commands.Profile/help/Set-AzureRmEnvironment.md index 671e38381768..df4fb81b8214 100644 --- a/src/ResourceManager/Profile/Commands.Profile/help/Set-AzureRmEnvironment.md +++ b/src/ResourceManager/Profile/Commands.Profile/help/Set-AzureRmEnvironment.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Profile.dll-Help.xml +Module Name: AzureRM.Profile online version: schema: 2.0.0 --- @@ -29,8 +30,9 @@ Set-AzureRmEnvironment [-Name] [[-PublishSettingsFileUrl] ] [[- ### ARMEndpoint ``` Set-AzureRmEnvironment [-Name] [[-StorageEndpoint] ] [-ARMEndpoint] - [[-AzureKeyVaultDnsSuffix] ] [[-DataLakeAudience] ] [-Scope ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [[-AzureKeyVaultDnsSuffix] ] [[-AzureKeyVaultServiceEndpointResourceId] ] + [[-DataLakeAudience] ] [-Scope ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -207,7 +209,7 @@ Specifies the audience for access tokens that authorize requests for Key Vault s ```yaml Type: String -Parameter Sets: Name +Parameter Sets: (All) Aliases: Required: False diff --git a/src/ResourceManager/Resources/Commands.Resources/help/AzureRM.Resources.md b/src/ResourceManager/Resources/Commands.Resources/help/AzureRM.Resources.md index 6ad898318700..43ab3ed643b2 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/AzureRM.Resources.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/AzureRM.Resources.md @@ -44,11 +44,11 @@ Filters active directory users. ### [Get-AzureRmLocation](Get-AzureRmLocation.md) Gets all locations and the supported resource providers for each location. -### [Get-AzureRmManagedApplicationDefinition](Get-AzureRmManagedApplicationDefinition.md) -Gets managed application definitions. - ### [Get-AzureRmManagedApplication](Get-AzureRmManagedApplication.md) -Gets managed applications. +Gets managed applications + +### [Get-AzureRmManagedApplicationDefinition](Get-AzureRmManagedApplicationDefinition.md) +Gets managed application definitions ### [Get-AzureRmPolicyAssignment](Get-AzureRmPolicyAssignment.md) Gets policy assignments. @@ -112,11 +112,11 @@ Adds a credential to an existing service principal. ### [New-AzureRmADUser](New-AzureRmADUser.md) Creates a new active directory user. -### [New-AzureRmManagedApplicationDefinition](New-AzureRmManagedApplicationDefinition.md) -Creates managed application definitions. - ### [New-AzureRmManagedApplication](New-AzureRmManagedApplication.md) -Creates managed applications. +Creates an Azure managed application. + +### [New-AzureRmManagedApplicationDefinition](New-AzureRmManagedApplicationDefinition.md) +Creates a managed application definition. ### [New-AzureRmPolicyAssignment](New-AzureRmPolicyAssignment.md) Creates a policy assignment. @@ -170,11 +170,11 @@ Removes a credential from a service principal. ### [Remove-AzureRmADUser](Remove-AzureRmADUser.md) Deletes an active directory user. -### [Remove-AzureRmManagedApplicationDefinition](Remove-AzureRmManagedApplicationDefinition.md) -Removes managed application definitions. - ### [Remove-AzureRmManagedApplication](Remove-AzureRmManagedApplication.md) -Removes managed applications. +Removes a managed application + +### [Remove-AzureRmManagedApplicationDefinition](Remove-AzureRmManagedApplicationDefinition.md) +Removes a managed application definition ### [Remove-AzureRmPolicyAssignment](Remove-AzureRmPolicyAssignment.md) Removes a policy assignment. @@ -217,11 +217,11 @@ Updates an existing azure active directory service principal. ### [Set-AzureRmADUser](Set-AzureRmADUser.md) Updates an existing active directory user. -### [Set-AzureRmManagedApplicationDefinition](Set-AzureRmManagedApplicationDefinition.md) -Updates an existing managed application definition. - ### [Set-AzureRmManagedApplication](Set-AzureRmManagedApplication.md) -Updates an existing managed application. +Updates managed application + +### [Set-AzureRmManagedApplicationDefinition](Set-AzureRmManagedApplicationDefinition.md) +Updates managed application definition ### [Set-AzureRmPolicyAssignment](Set-AzureRmPolicyAssignment.md) Modifies a policy assignment. @@ -230,7 +230,7 @@ Modifies a policy assignment. Modifies a policy definition. ### [Set-AzureRmPolicySetDefinition](Set-AzureRmPolicySetDefinition.md) -Modifies a policy set definition. +Modifies a policy set definition ### [Set-AzureRmResource](Set-AzureRmResource.md) Modifies a resource. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Export-AzureRmResourceGroup.md b/src/ResourceManager/Resources/Commands.Resources/help/Export-AzureRmResourceGroup.md index 7ec6647e5729..4d06c02ef614 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Export-AzureRmResourceGroup.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Export-AzureRmResourceGroup.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 63BBDF98-75FC-4A44-9FD0-95AD21ED93A6 online version: schema: 2.0.0 @@ -14,8 +15,9 @@ Captures a resource group as a template and saves it to a file. ``` Export-AzureRmResourceGroup -ResourceGroupName [-Path ] [-IncludeParameterDefaultValue] - [-IncludeComments] [-Force] [-ApiVersion ] [-Pre] [-InformationAction ] - [-InformationVariable ] [-WhatIf] [-Confirm] [] + [-IncludeComments] [-Force] [-ApiVersion ] [-Pre] [-DefaultProfile ] + [-InformationAction ] [-InformationVariable ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -53,6 +55,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Find-AzureRmResource.md b/src/ResourceManager/Resources/Commands.Resources/help/Find-AzureRmResource.md index 6f2bcc132d26..e30c0c7d3acc 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Find-AzureRmResource.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Find-AzureRmResource.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: BB90E6BB-7F53-4441-A7B2-EDA940621D49 -online version: +online version: schema: 2.0.0 --- @@ -17,15 +18,16 @@ Searches for resources based on specified parameters. Find-AzureRmResource [-ResourceNameContains ] [-ResourceNameEquals ] [-ResourceType ] [-ExtensionResourceType ] [-Top ] [-ODataQuery ] [-ResourceGroupNameContains ] [-ResourceGroupNameEquals ] [-ExpandProperties] [-ApiVersion ] [-Pre] - [-InformationAction ] [-InformationVariable ] [] + [-DefaultProfile ] [-InformationAction ] + [-InformationVariable ] [] ``` ### Lists the resources based on the specified scope at the tenant level. ``` Find-AzureRmResource [-ResourceNameContains ] [-ResourceNameEquals ] -ResourceType [-ExtensionResourceType ] [-Top ] [-ODataQuery ] [-ExpandProperties] [-TenantLevel] - [-ApiVersion ] [-Pre] [-InformationAction ] [-InformationVariable ] - [] + [-ApiVersion ] [-Pre] [-DefaultProfile ] + [-InformationAction ] [-InformationVariable ] [] ``` ### Get a resources using a multi-subscription query. @@ -33,21 +35,22 @@ Find-AzureRmResource [-ResourceNameContains ] [-ResourceNameEquals ] [-ResourceNameEquals ] -ResourceType [-ExtensionResourceType ] [-Top ] [-ODataQuery ] [-ResourceGroupNameContains ] [-ResourceGroupNameEquals ] [-ExpandProperties] [-ApiVersion ] [-Pre] - [-InformationAction ] [-InformationVariable ] [] + [-DefaultProfile ] [-InformationAction ] + [-InformationVariable ] [] ``` ### Lists resources by a tag object specified as a hashset. ``` Find-AzureRmResource [-Top ] [-ODataQuery ] [-Tag ] [-ExpandProperties] - [-ApiVersion ] [-Pre] [-InformationAction ] [-InformationVariable ] - [] + [-ApiVersion ] [-Pre] [-DefaultProfile ] + [-InformationAction ] [-InformationVariable ] [] ``` ### Lists resources by a tag specified as a individual name and value parameters. ``` Find-AzureRmResource [-Top ] [-ODataQuery ] [-TagName ] [-TagValue ] - [-ExpandProperties] [-ApiVersion ] [-Pre] [-InformationAction ] - [-InformationVariable ] [] + [-ExpandProperties] [-ApiVersion ] [-Pre] [-DefaultProfile ] + [-InformationAction ] [-InformationVariable ] [] ``` ## DESCRIPTION @@ -78,7 +81,22 @@ If you do not specify a version, this cmdlet uses the latest available version. ```yaml Type: String Parameter Sets: (All) -Aliases: +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: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential Required: False Position: Named @@ -93,7 +111,7 @@ Indicates that this cmdlet expands the properties of the resource. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -111,7 +129,7 @@ For instance: ```yaml Type: String Parameter Sets: Lists the resources based on the specified scope., Lists the resources based on the specified scope at the tenant level., Get a resources using a multi-subscription query. -Aliases: +Aliases: Required: False Position: Named @@ -166,7 +184,7 @@ This cmdlet appends this value to the request in addition to any other filters. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -181,7 +199,7 @@ Indicates that this cmdlet considers pre-release API versions when it automatica ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -213,7 +231,7 @@ The resource group name for a full match. ```yaml Type: String Parameter Sets: Lists the resources based on the specified scope., Get a resources using a multi-subscription query. -Aliases: +Aliases: Required: False Position: Named @@ -244,7 +262,7 @@ The resource name for a full match. e.g. if your resource name is testResource, ```yaml Type: String Parameter Sets: Lists the resources based on the specified scope., Lists the resources based on the specified scope at the tenant level., Get a resources using a multi-subscription query. -Aliases: +Aliases: Required: False Position: Named @@ -264,7 +282,7 @@ This cmdlet searches for resources of the specified type. ```yaml Type: String Parameter Sets: Lists the resources based on the specified scope. -Aliases: +Aliases: Required: False Position: Named @@ -276,7 +294,7 @@ Accept wildcard characters: False ```yaml Type: String Parameter Sets: Lists the resources based on the specified scope at the tenant level., Get a resources using a multi-subscription query. -Aliases: +Aliases: Required: True Position: Named @@ -291,7 +309,7 @@ The tag filter for the OData query. The expected format is @{tagName=$null} or @ ```yaml Type: Hashtable Parameter Sets: Lists resources by a tag object specified as a hashset. -Aliases: +Aliases: Required: False Position: Named @@ -304,7 +322,7 @@ Accept wildcard characters: False ```yaml Type: String Parameter Sets: Lists resources by a tag specified as a individual name and value parameters. -Aliases: +Aliases: Required: False Position: Named @@ -317,7 +335,7 @@ Accept wildcard characters: False ```yaml Type: String Parameter Sets: Lists resources by a tag specified as a individual name and value parameters. -Aliases: +Aliases: Required: False Position: Named @@ -332,7 +350,7 @@ Indicates that this cmdlet operates at the tenant level. ```yaml Type: SwitchParameter Parameter Sets: Lists the resources based on the specified scope at the tenant level. -Aliases: +Aliases: Required: True Position: Named @@ -347,7 +365,7 @@ Specifies the number of resources to retrieve. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Find-AzureRmResourceGroup.md b/src/ResourceManager/Resources/Commands.Resources/help/Find-AzureRmResourceGroup.md index fb989a0a8fe7..184d1cd00ce1 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Find-AzureRmResourceGroup.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Find-AzureRmResourceGroup.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: EFBBFB60-D972-47B8-997E-B737F0CA007E -online version: +online version: schema: 2.0.0 --- @@ -13,7 +14,8 @@ Searches for resource groups. ## SYNTAX ``` -Find-AzureRmResourceGroup [-Tag ] [-ApiVersion ] [-Pre] [] +Find-AzureRmResourceGroup [-Tag ] [-ApiVersion ] [-Pre] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -51,7 +53,22 @@ cmdlet uses the latest available version. ```yaml Type: String Parameter Sets: (All) -Aliases: +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: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential Required: False Position: Named @@ -66,7 +83,7 @@ Indicates that this cmdlet considers pre-release API versions when it automatica ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -83,7 +100,7 @@ Specifies tag information, as a hash table, to filter your results. Use the foll ```yaml Type: Hashtable Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -104,3 +121,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES ## RELATED LINKS + diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADAppCredential.md b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADAppCredential.md index 6eb06bbf7a56..412c84a55c9e 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADAppCredential.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADAppCredential.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 6AC9DA05-756D-4D59-BD97-DBAAFBB3C7AC online version: schema: 2.0.0 @@ -14,12 +15,13 @@ Retrieves a list of credentials associated with an application. ### ApplicationObjectIdParameterSet (Default) ``` -Get-AzureRmADAppCredential -ObjectId [] +Get-AzureRmADAppCredential -ObjectId [-DefaultProfile ] [] ``` ### ApplicationIdParameterSet ``` -Get-AzureRmADAppCredential -ApplicationId [] +Get-AzureRmADAppCredential -ApplicationId [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -53,6 +55,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ObjectId The object id of the application to retrieve credentials from. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADApplication.md b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADApplication.md index c1eadae896a9..6fb3c4da6aaa 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADApplication.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADApplication.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 66AC5120-80B1-46F2-AA51-132BF361602E online version: schema: 2.0.0 @@ -14,27 +15,29 @@ Lists existing azure active directory applications. ### EmptyParameterSet (Default) ``` -Get-AzureRmADApplication [] +Get-AzureRmADApplication [-DefaultProfile ] [] ``` ### ApplicationObjectIdParameterSet ``` -Get-AzureRmADApplication -ObjectId [] +Get-AzureRmADApplication -ObjectId [-DefaultProfile ] [] ``` ### ApplicationIdParameterSet ``` -Get-AzureRmADApplication -ApplicationId [] +Get-AzureRmADApplication -ApplicationId [-DefaultProfile ] [] ``` ### ApplicationDisplayNameParameterSet ``` -Get-AzureRmADApplication -DisplayNameStartWith [] +Get-AzureRmADApplication -DisplayNameStartWith [-DefaultProfile ] + [] ``` ### ApplicationIdentifierUriParameterSet ``` -Get-AzureRmADApplication -IdentifierUri [] +Get-AzureRmADApplication -IdentifierUri [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -75,6 +78,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DisplayNameStartWith Fetch all applications starting with the display name. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADGroup.md b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADGroup.md index 4d37eb661aa7..0ceb7e52e12f 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADGroup.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADGroup.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 85DDA491-7A7D-4217-B0E3-72CDC3787889 online version: schema: 2.0.0 @@ -14,17 +15,17 @@ Filters active directory groups. ### EmptyParameterSet (Default) ``` -Get-AzureRmADGroup [-ObjectId ] [] +Get-AzureRmADGroup [-ObjectId ] [-DefaultProfile ] [] ``` ### SearchStringParameterSet ``` -Get-AzureRmADGroup -SearchString [] +Get-AzureRmADGroup -SearchString [-DefaultProfile ] [] ``` ### ObjectIdParameterSet ``` -Get-AzureRmADGroup -ObjectId [] +Get-AzureRmADGroup -ObjectId [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -55,6 +56,21 @@ Gets all AD groups ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ObjectId Object id of the group. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADGroupMember.md b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADGroupMember.md index c83dc5d5e3d6..46f2cfee4d25 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADGroupMember.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADGroupMember.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 52C5CD8B-2489-4FE6-9F33-B3350531CD8E online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Get a group members. ## SYNTAX ``` -Get-AzureRmADGroupMember [-GroupObjectId ] [] +Get-AzureRmADGroupMember [-GroupObjectId ] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -30,6 +32,21 @@ Gets group members with 85F89C90-780E-4AA6-9F4F-6F268D322EEE id ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -GroupObjectId Object id of the group. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADServicePrincipal.md b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADServicePrincipal.md index f59a347ba491..1238b796286c 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADServicePrincipal.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADServicePrincipal.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 4DC26C26-6162-4A15-BFCB-4D2B6B52DD81 online version: schema: 2.0.0 @@ -14,22 +15,25 @@ Filters active directory service principals. ### EmptyParameterSet (Default) ``` -Get-AzureRmADServicePrincipal [-ServicePrincipalName ] [] +Get-AzureRmADServicePrincipal [-ServicePrincipalName ] [-DefaultProfile ] + [] ``` ### SearchStringParameterSet ``` -Get-AzureRmADServicePrincipal -SearchString [] +Get-AzureRmADServicePrincipal -SearchString [-DefaultProfile ] + [] ``` ### ObjectIdParameterSet ``` -Get-AzureRmADServicePrincipal -ObjectId [] +Get-AzureRmADServicePrincipal -ObjectId [-DefaultProfile ] [] ``` ### SPNParameterSet ``` -Get-AzureRmADServicePrincipal -ServicePrincipalName [] +Get-AzureRmADServicePrincipal -ServicePrincipalName [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -60,6 +64,21 @@ Gets all AD service principals. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ObjectId Object id of the service principal. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADSpCredential.md b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADSpCredential.md index d7aa2c9cdf68..20ada2420181 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADSpCredential.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADSpCredential.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 7690143F-5F09-4739-9F66-B2ACDF8305F4 online version: schema: 2.0.0 @@ -14,12 +15,13 @@ Retrieves a list of credentials associated with a service principal. ### ObjectIdParameterSet (Default) ``` -Get-AzureRmADSpCredential -ObjectId [] +Get-AzureRmADSpCredential -ObjectId [-DefaultProfile ] [] ``` ### SPNParameterSet ``` -Get-AzureRmADSpCredential -ServicePrincipalName [] +Get-AzureRmADSpCredential -ServicePrincipalName [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -37,6 +39,21 @@ Returns a list of credentials associated with the service principal having SPN ' ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ObjectId The object id of the service principal to retrieve credentials from. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADUser.md b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADUser.md index 9e1ccb3accdc..ad15597f6c36 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADUser.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmADUser.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: BF254F2F-F658-45CC-8AC8-53FF96CFCAAD online version: schema: 2.0.0 @@ -14,27 +15,27 @@ Filters active directory users. ### EmptyParameterSet (Default) ``` -Get-AzureRmADUser [-UserPrincipalName ] [] +Get-AzureRmADUser [-UserPrincipalName ] [-DefaultProfile ] [] ``` ### SearchStringParameterSet ``` -Get-AzureRmADUser -SearchString [] +Get-AzureRmADUser -SearchString [-DefaultProfile ] [] ``` ### ObjectIdParameterSet ``` -Get-AzureRmADUser -ObjectId [] +Get-AzureRmADUser -ObjectId [-DefaultProfile ] [] ``` ### UPNParameterSet ``` -Get-AzureRmADUser -UserPrincipalName [] +Get-AzureRmADUser -UserPrincipalName [-DefaultProfile ] [] ``` ### MailParameterSet ``` -Get-AzureRmADUser -Mail [] +Get-AzureRmADUser -Mail [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -65,6 +66,21 @@ Gets all AD users ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Mail ```yaml Type: String diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmLocation.md b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmLocation.md index 3087088b6180..22a0225b38e1 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmLocation.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmLocation.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: DC870E11-2129-4906-8357-D9BC1CF2E08E online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Gets all locations and the supported resource providers for each location. ## SYNTAX ``` -Get-AzureRmLocation [-ApiVersion ] [-Pre] [] +Get-AzureRmLocation [-ApiVersion ] [-Pre] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -46,6 +48,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Pre Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmManagedApplication.md b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmManagedApplication.md index efc8d338ee5e..70f577ba860c 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmManagedApplication.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmManagedApplication.md @@ -15,18 +15,19 @@ Gets managed applications ### The list all managed applications parameter set. (Default) ``` Get-AzureRmManagedApplication [-ApiVersion ] [-Pre] [-DefaultProfile ] + [] ``` ### The managed application name parameter set. ``` Get-AzureRmManagedApplication [-Name ] -ResourceGroupName [-ApiVersion ] [-Pre] - [-DefaultProfile ] + [-DefaultProfile ] [] ``` ### The managed application Id parameter set. ``` Get-AzureRmManagedApplication -Id [-ApiVersion ] [-Pre] - [-DefaultProfile ] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -143,16 +144,17 @@ Accept pipeline input: True (ByPropertyName) 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 - ## OUTPUTS ### System.Management.Automation.PSObject - ## NOTES ## RELATED LINKS diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmManagedApplicationDefinition.md b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmManagedApplicationDefinition.md index 47e7412a253c..5e36c5a42dc7 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmManagedApplicationDefinition.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmManagedApplicationDefinition.md @@ -15,13 +15,13 @@ Gets managed application definitions ### The managed application definition name parameter set. (Default) ``` Get-AzureRmManagedApplicationDefinition [-Name ] -ResourceGroupName [-ApiVersion ] - [-Pre] [-DefaultProfile ] + [-Pre] [-DefaultProfile ] [] ``` ### The managed application definition Id parameter set. ``` Get-AzureRmManagedApplicationDefinition -Id [-ApiVersion ] [-Pre] - [-DefaultProfile ] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -138,16 +138,17 @@ Accept pipeline input: True (ByPropertyName) 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 - ## OUTPUTS ### System.Management.Automation.PSObject - ## NOTES ## RELATED LINKS diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmPolicyAssignment.md b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmPolicyAssignment.md index 7caa2391729a..06d453a2c54f 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmPolicyAssignment.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmPolicyAssignment.md @@ -15,21 +15,22 @@ Gets policy assignments. ### The list all policy assignments parameter set. (Default) ``` -Get-AzureRmPolicyAssignment [-ApiVersion ] [-Pre] [-InformationAction ] - [-InformationVariable ] [] +Get-AzureRmPolicyAssignment [-ApiVersion ] [-Pre] [-DefaultProfile ] + [-InformationAction ] [-InformationVariable ] [] ``` ### The policy assignment name parameter set. ``` Get-AzureRmPolicyAssignment [-Name ] -Scope [-PolicyDefinitionId ] - [-ApiVersion ] [-Pre] [-InformationAction ] [-InformationVariable ] - [] + [-ApiVersion ] [-Pre] [-DefaultProfile ] + [-InformationAction ] [-InformationVariable ] [] ``` ### The policy assignment Id parameter set. ``` Get-AzureRmPolicyAssignment -Id [-PolicyDefinitionId ] [-ApiVersion ] [-Pre] - [-InformationAction ] [-InformationVariable ] [] + [-DefaultProfile ] [-InformationAction ] + [-InformationVariable ] [] ``` ## DESCRIPTION @@ -74,6 +75,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id Specifies the fully qualified resource ID for the policy assignment that this cmdlet gets. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmPolicyDefinition.md b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmPolicyDefinition.md index 6a9ad3201032..9e4bebf08d8e 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmPolicyDefinition.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmPolicyDefinition.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 6396AEC3-DFE6-45DA-BCF4-69C55C5D051B online version: schema: 2.0.0 @@ -14,19 +15,21 @@ Gets policy definitions. ### The list all policy definitions parameter set. (Default) ``` -Get-AzureRmPolicyDefinition [-ApiVersion ] [-Pre] [-InformationAction ] - [-InformationVariable ] [] +Get-AzureRmPolicyDefinition [-ApiVersion ] [-Pre] [-DefaultProfile ] + [-InformationAction ] [-InformationVariable ] [] ``` ### The policy definition name parameter set. ``` Get-AzureRmPolicyDefinition -Name [-ApiVersion ] [-Pre] - [-InformationAction ] [-InformationVariable ] [] + [-DefaultProfile ] [-InformationAction ] + [-InformationVariable ] [] ``` ### The policy definition Id parameter set. ``` -Get-AzureRmPolicyDefinition -Id [-ApiVersion ] [-Pre] [-InformationAction ] +Get-AzureRmPolicyDefinition -Id [-ApiVersion ] [-Pre] + [-DefaultProfile ] [-InformationAction ] [-InformationVariable ] [] ``` @@ -67,6 +70,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id Specifies the fully qualified resource ID for the policy definition that this cmdlet gets. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmPolicySetDefinition.md b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmPolicySetDefinition.md index f5bd802ecc59..b002fcaa049e 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmPolicySetDefinition.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmPolicySetDefinition.md @@ -14,17 +14,20 @@ Gets policy set definitions. ### The list all policy set definitions parameter set. (Default) ``` -Get-AzureRmPolicySetDefinition [-ApiVersion ] [-Pre] [] +Get-AzureRmPolicySetDefinition [-ApiVersion ] [-Pre] [-DefaultProfile ] + [] ``` ### The policy set definition name parameter set. ``` -Get-AzureRmPolicySetDefinition -Name [-ApiVersion ] [-Pre] [] +Get-AzureRmPolicySetDefinition -Name [-ApiVersion ] [-Pre] + [-DefaultProfile ] [] ``` ### The policy set definition Id parameter set. ``` -Get-AzureRmPolicySetDefinition -Id [-ApiVersion ] [-Pre] [] +Get-AzureRmPolicySetDefinition -Id [-ApiVersion ] [-Pre] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -64,6 +67,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id The fully qualified policy set definition Id, including the subscription. e.g. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmProviderFeature.md b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmProviderFeature.md index 9dd9fc9bdcb1..d3d6fd61f0cd 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmProviderFeature.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmProviderFeature.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 2970E81E-A788-4829-B1FF-B522A91DE4B1 online version: schema: 2.0.0 @@ -14,12 +15,14 @@ Gets information about Azure provider features. ### ListAvailableParameterSet (Default) ``` -Get-AzureRmProviderFeature [-ProviderNamespace ] [-ListAvailable] [] +Get-AzureRmProviderFeature [-ProviderNamespace ] [-ListAvailable] + [-DefaultProfile ] [] ``` ### GetFeature ``` -Get-AzureRmProviderFeature -ProviderNamespace -FeatureName [] +Get-AzureRmProviderFeature -ProviderNamespace -FeatureName + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -43,6 +46,21 @@ This command gets information for the feature named AllowPreReleaseRegions for t ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -FeatureName Specifies the name of the feature to get. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmProviderOperation.md b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmProviderOperation.md index 895a6d5d51c4..6f073eaf885a 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmProviderOperation.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmProviderOperation.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 6424B740-DBFB-490C-AEAA-EDD60952B435 online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Gets the operations for an Azure resource provider that are securable using Azur ## SYNTAX ``` -Get-AzureRmProviderOperation [-OperationSearchString] [] +Get-AzureRmProviderOperation [-OperationSearchString] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -44,6 +46,21 @@ PS C:\> Get-AzureRmProviderOperation */virtualMachines/* ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OperationSearchString The operation search string (with possible wildcard (*) characters) @@ -65,7 +82,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### String - Parameter 'OperationSearchString' accepts value of type 'String' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResource.md b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResource.md index 45fa58047c7f..af6d96c1cf43 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResource.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResource.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: C2C608E5-3351-4D01-8533-9668B2E9F1D1 online version: schema: 2.0.0 @@ -15,55 +16,56 @@ Gets resources. ### The list all resources parameter set. (Default) ``` Get-AzureRmResource [-ExpandProperties] [-ODataQuery ] [-ApiVersion ] [-Pre] - [] + [-DefaultProfile ] [] ``` ### Get a single resource by its Id. ``` Get-AzureRmResource -ResourceId [-ExpandProperties] [-ODataQuery ] [-ApiVersion ] - [-Pre] [] + [-Pre] [-DefaultProfile ] [] ``` ### Get a single resource at the tenant level. ``` Get-AzureRmResource -ResourceName -ResourceType [-ExtensionResourceName ] [-ExtensionResourceType ] [-ExpandProperties] [-IsCollection] [-ODataQuery ] [-TenantLevel] - [-ApiVersion ] [-Pre] [] + [-ApiVersion ] [-Pre] [-DefaultProfile ] [] ``` ### Lists the resources based on the specified scope at the tenant level. ``` Get-AzureRmResource [-ResourceName ] [-ResourceType ] [-ExtensionResourceName ] [-ExtensionResourceType ] [-ExpandProperties] [-IsCollection] [-Top ] [-ODataQuery ] - [-TenantLevel] [-ApiVersion ] [-Pre] [] + [-TenantLevel] [-ApiVersion ] [-Pre] [-DefaultProfile ] [] ``` ### Get resource by name and group ``` Get-AzureRmResource [-ResourceName ] [-ExtensionResourceName ] [-ExtensionResourceType ] [-ExpandProperties] [-IsCollection] [-ODataQuery ] - [-ResourceGroupName ] [-ApiVersion ] [-Pre] [] + [-ResourceGroupName ] [-ApiVersion ] [-Pre] [-DefaultProfile ] + [] ``` ### Get a resource by name and type. ``` Get-AzureRmResource [-ResourceName ] [-ResourceType ] [-ExtensionResourceName ] [-ExtensionResourceType ] [-ExpandProperties] [-IsCollection] [-ODataQuery ] - [-ApiVersion ] [-Pre] [] + [-ApiVersion ] [-Pre] [-DefaultProfile ] [] ``` ### Get resource by name, group and type ``` Get-AzureRmResource -ResourceName -ResourceType [-ExtensionResourceName ] [-ExtensionResourceType ] [-ExpandProperties] [-ODataQuery ] -ResourceGroupName - [-ApiVersion ] [-Pre] [] + [-ApiVersion ] [-Pre] [-DefaultProfile ] [] ``` ### Get resource collection ``` Get-AzureRmResource [-ResourceType ] [-ExtensionResourceType ] [-ExpandProperties] [-IsCollection] [-ODataQuery ] [-ResourceGroupName ] [-ApiVersion ] [-Pre] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -108,6 +110,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExpandProperties ```yaml Type: SwitchParameter diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResourceGroup.md b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResourceGroup.md index b0ceb268abd4..137cbe67480b 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResourceGroup.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResourceGroup.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 5B17A241-BF36-48A6-BC29-4C32C08F5F94 online version: schema: 2.0.0 @@ -15,12 +16,13 @@ Gets resource groups. ### Lists the resource group based on the name. (Default) ``` Get-AzureRmResourceGroup [-Name ] [-Location ] [-ApiVersion ] [-Pre] - [] + [-DefaultProfile ] [] ``` ### Lists the resource group based on the Id. ``` -Get-AzureRmResourceGroup [-Location ] [-Id ] [-ApiVersion ] [-Pre] [] +Get-AzureRmResourceGroup [-Location ] [-Id ] [-ApiVersion ] [-Pre] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -83,6 +85,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id Specifies the ID of the resource group to get. Wildcard characters are not permitted. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResourceGroupDeployment.md b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResourceGroupDeployment.md index 429d7958d47b..be12b42fc46c 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResourceGroupDeployment.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResourceGroupDeployment.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 20CB842B-F7A9-4052-85D9-0DF9586D5FEA online version: schema: 2.0.0 @@ -15,12 +16,13 @@ Gets the deployments in a resource group. ### The deployment name parameter set. (Default) ``` Get-AzureRmResourceGroupDeployment [-ResourceGroupName] [[-Name] ] [-ApiVersion ] - [-Pre] [] + [-Pre] [-DefaultProfile ] [] ``` ### The deployment Id parameter set. ``` -Get-AzureRmResourceGroupDeployment -Id [-ApiVersion ] [-Pre] [] +Get-AzureRmResourceGroupDeployment -Id [-ApiVersion ] [-Pre] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -83,6 +85,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id Specifies the ID of the resource group deployment to get. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResourceGroupDeploymentOperation.md b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResourceGroupDeploymentOperation.md index 6df1551d40a8..ab1e80f20875 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResourceGroupDeploymentOperation.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResourceGroupDeploymentOperation.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 9F29DFCB-A02B-45A5-99B9-C054BF4FCA6C online version: schema: 2.0.0 @@ -14,8 +15,8 @@ Gets the resource group deployment operation ``` Get-AzureRmResourceGroupDeploymentOperation -DeploymentName [-SubscriptionId ] - -ResourceGroupName [-ApiVersion ] [-Pre] [-InformationAction ] - [-InformationVariable ] [] + -ResourceGroupName [-ApiVersion ] [-Pre] [-DefaultProfile ] + [-InformationAction ] [-InformationVariable ] [] ``` ## DESCRIPTION @@ -54,6 +55,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DeploymentName The deployment name. @@ -159,7 +175,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Guid - Parameter 'SubscriptionId' accepts value of type 'Guid' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResourceLock.md b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResourceLock.md index 14b981cb7cdc..5e46639d1b2a 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResourceLock.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResourceLock.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 3FBF91B8-8EF9-4E05-AD7E-AEFC6EBBFB8E online version: schema: 2.0.0 @@ -15,46 +16,50 @@ Gets a resource lock. ### A lock at the resource group scope. ``` Get-AzureRmResourceLock [-LockName ] [-AtScope] -ResourceGroupName [-ApiVersion ] - [-Pre] [-InformationAction ] [-InformationVariable ] [] + [-Pre] [-DefaultProfile ] [-InformationAction ] + [-InformationVariable ] [] ``` ### A lock at the resource group resource scope. ``` Get-AzureRmResourceLock [-LockName ] [-AtScope] -ResourceName -ResourceType - -ResourceGroupName [-ApiVersion ] [-Pre] [-InformationAction ] - [-InformationVariable ] [] + -ResourceGroupName [-ApiVersion ] [-Pre] [-DefaultProfile ] + [-InformationAction ] [-InformationVariable ] [] ``` ### A lock at the specified scope. ``` Get-AzureRmResourceLock [-LockName ] [-AtScope] -Scope [-ApiVersion ] [-Pre] - [-InformationAction ] [-InformationVariable ] [] + [-DefaultProfile ] [-InformationAction ] + [-InformationVariable ] [] ``` ### A lock at the subscription scope. ``` Get-AzureRmResourceLock [-LockName ] [-AtScope] [-ApiVersion ] [-Pre] - [-InformationAction ] [-InformationVariable ] [] + [-DefaultProfile ] [-InformationAction ] + [-InformationVariable ] [] ``` ### A lock at the subscription resource scope. ``` Get-AzureRmResourceLock [-LockName ] [-AtScope] -ResourceName -ResourceType - [-ApiVersion ] [-Pre] [-InformationAction ] [-InformationVariable ] - [] + [-ApiVersion ] [-Pre] [-DefaultProfile ] + [-InformationAction ] [-InformationVariable ] [] ``` ### A lock at the tenant resource scope. ``` Get-AzureRmResourceLock [-LockName ] [-AtScope] -ResourceName -ResourceType - [-TenantLevel] [-ApiVersion ] [-Pre] [-InformationAction ] - [-InformationVariable ] [] + [-TenantLevel] [-ApiVersion ] [-Pre] [-DefaultProfile ] + [-InformationAction ] [-InformationVariable ] [] ``` ### A lock, by Id. ``` Get-AzureRmResourceLock [-AtScope] -LockId [-ApiVersion ] [-Pre] - [-InformationAction ] [-InformationVariable ] [] + [-DefaultProfile ] [-InformationAction ] + [-InformationVariable ] [] ``` ## DESCRIPTION @@ -103,6 +108,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InformationAction Specifies how this cmdlet responds to an information event. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResourceProvider.md b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResourceProvider.md index a2d1b2751316..cf4b194069c9 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResourceProvider.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmResourceProvider.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 6AB09621-488B-4A16-92D9-9C47EB87DA95 online version: schema: 2.0.0 @@ -15,13 +16,13 @@ Gets a resource provider. ### ListAvailable (Default) ``` Get-AzureRmResourceProvider [-Location ] [-ListAvailable] [-ApiVersion ] [-Pre] - [] + [-DefaultProfile ] [] ``` ### IndividualProvider ``` Get-AzureRmResourceProvider -ProviderNamespace [-Location ] [-ApiVersion ] [-Pre] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -52,6 +53,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ListAvailable Indicates that this operation gets all available resource providers. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmRoleAssignment.md b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmRoleAssignment.md index 8f7e3538429d..4447c13c4248 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmRoleAssignment.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmRoleAssignment.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 488229AF-FD6D-4E1B-B3DA-E57CA781D91E online version: schema: 2.0.0 @@ -16,105 +17,109 @@ Use respective parameters to list assignments to a specific user, or to list ass ### EmptyParameterSet (Default) ``` -Get-AzureRmRoleAssignment [-RoleDefinitionName ] [-IncludeClassicAdministrators] [] +Get-AzureRmRoleAssignment [-RoleDefinitionName ] [-IncludeClassicAdministrators] + [-DefaultProfile ] [] ``` ### ObjectIdParameterSet ``` Get-AzureRmRoleAssignment -ObjectId [-RoleDefinitionName ] [-ExpandPrincipalGroups] - [-IncludeClassicAdministrators] [] + [-IncludeClassicAdministrators] [-DefaultProfile ] [] ``` ### ResourceGroupWithObjectIdParameterSet ``` Get-AzureRmRoleAssignment -ObjectId -ResourceGroupName [-RoleDefinitionName ] - [-IncludeClassicAdministrators] [] + [-IncludeClassicAdministrators] [-DefaultProfile ] [] ``` ### ResourceWithObjectIdParameterSet ``` Get-AzureRmRoleAssignment -ObjectId -ResourceGroupName -ResourceName -ResourceType [-ParentResource ] [-RoleDefinitionName ] - [-IncludeClassicAdministrators] [] + [-IncludeClassicAdministrators] [-DefaultProfile ] [] ``` ### ScopeWithObjectIdParameterSet ``` Get-AzureRmRoleAssignment -ObjectId [-RoleDefinitionName ] -Scope - [-IncludeClassicAdministrators] [] + [-IncludeClassicAdministrators] [-DefaultProfile ] [] ``` ### RoleIdWithScopeAndObjectIdParameterSet ``` -Get-AzureRmRoleAssignment [-ObjectId ] -RoleDefinitionId [-Scope ] [] +Get-AzureRmRoleAssignment [-ObjectId ] -RoleDefinitionId [-Scope ] + [-DefaultProfile ] [] ``` ### ResourceGroupWithSignInNameParameterSet ``` Get-AzureRmRoleAssignment -SignInName -ResourceGroupName [-RoleDefinitionName ] - [-IncludeClassicAdministrators] [] + [-IncludeClassicAdministrators] [-DefaultProfile ] [] ``` ### ResourceWithSignInNameParameterSet ``` Get-AzureRmRoleAssignment -SignInName -ResourceGroupName -ResourceName -ResourceType [-ParentResource ] [-RoleDefinitionName ] - [-IncludeClassicAdministrators] [] + [-IncludeClassicAdministrators] [-DefaultProfile ] [] ``` ### ScopeWithSignInNameParameterSet ``` Get-AzureRmRoleAssignment -SignInName [-RoleDefinitionName ] -Scope - [-IncludeClassicAdministrators] [] + [-IncludeClassicAdministrators] [-DefaultProfile ] [] ``` ### SignInNameParameterSet ``` Get-AzureRmRoleAssignment -SignInName [-RoleDefinitionName ] [-ExpandPrincipalGroups] - [-IncludeClassicAdministrators] [] + [-IncludeClassicAdministrators] [-DefaultProfile ] [] ``` ### ResourceGroupWithSPNParameterSet ``` Get-AzureRmRoleAssignment -ServicePrincipalName -ResourceGroupName - [-RoleDefinitionName ] [-IncludeClassicAdministrators] [] + [-RoleDefinitionName ] [-IncludeClassicAdministrators] [-DefaultProfile ] + [] ``` ### ResourceWithSPNParameterSet ``` Get-AzureRmRoleAssignment -ServicePrincipalName -ResourceGroupName -ResourceName -ResourceType [-ParentResource ] [-RoleDefinitionName ] - [-IncludeClassicAdministrators] [] + [-IncludeClassicAdministrators] [-DefaultProfile ] [] ``` ### ScopeWithSPNParameterSet ``` Get-AzureRmRoleAssignment -ServicePrincipalName [-RoleDefinitionName ] -Scope - [-IncludeClassicAdministrators] [] + [-IncludeClassicAdministrators] [-DefaultProfile ] [] ``` ### SPNParameterSet ``` Get-AzureRmRoleAssignment -ServicePrincipalName [-RoleDefinitionName ] - [-IncludeClassicAdministrators] [] + [-IncludeClassicAdministrators] [-DefaultProfile ] [] ``` ### ResourceGroupParameterSet ``` Get-AzureRmRoleAssignment -ResourceGroupName [-RoleDefinitionName ] - [-IncludeClassicAdministrators] [] + [-IncludeClassicAdministrators] [-DefaultProfile ] [] ``` ### ResourceParameterSet ``` Get-AzureRmRoleAssignment -ResourceGroupName -ResourceName -ResourceType - [-ParentResource ] [-RoleDefinitionName ] [-IncludeClassicAdministrators] [] + [-ParentResource ] [-RoleDefinitionName ] [-IncludeClassicAdministrators] + [-DefaultProfile ] [] ``` ### ScopeParameterSet ``` Get-AzureRmRoleAssignment [-RoleDefinitionName ] -Scope [-IncludeClassicAdministrators] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -180,6 +185,21 @@ Gets role assignments at the 'site1' website scope. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExpandPrincipalGroups If specified, returns roles directly assigned to the user and to the groups of which the user is a member (transitively). Supported only for a user principal. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmRoleDefinition.md b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmRoleDefinition.md index 35fb24a719ef..7c2c16428f85 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmRoleDefinition.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Get-AzureRmRoleDefinition.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 7740AC3B-F643-4F8D-8DC5-ACBF59323BD8 online version: schema: 2.0.0 @@ -14,17 +15,20 @@ Lists all Azure RBAC roles that are available for assignment. ### RoleDefinitionNameParameterSet ``` -Get-AzureRmRoleDefinition [[-Name] ] [-Scope ] [-AtScopeAndBelow] [] +Get-AzureRmRoleDefinition [[-Name] ] [-Scope ] [-AtScopeAndBelow] + [-DefaultProfile ] [] ``` ### RoleDefinitionIdParameterSet ``` -Get-AzureRmRoleDefinition -Id [-Scope ] [] +Get-AzureRmRoleDefinition -Id [-Scope ] [-DefaultProfile ] + [] ``` ### RoleDefinitionCustomParameterSet ``` -Get-AzureRmRoleDefinition [-Scope ] [-Custom] [-AtScopeAndBelow] [] +Get-AzureRmRoleDefinition [-Scope ] [-Custom] [-AtScopeAndBelow] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -79,6 +83,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id Role definition Id. @@ -132,7 +151,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### String - Parameter 'Scope' accepts value of type 'String' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Invoke-AzureRmResourceAction.md b/src/ResourceManager/Resources/Commands.Resources/help/Invoke-AzureRmResourceAction.md index 267c0a615736..3ee7426ee25a 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Invoke-AzureRmResourceAction.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Invoke-AzureRmResourceAction.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 427F7300-0FEB-4F28-9C1D-27592AEBF6A0 online version: schema: 2.0.0 @@ -15,8 +16,9 @@ Invokes an action on a resource. ### The resource Id. (Default) ``` Invoke-AzureRmResourceAction [-Parameters ] -Action -ResourceId - [-ODataQuery ] [-Force] [-ApiVersion ] [-Pre] [-InformationAction ] - [-InformationVariable ] [-WhatIf] [-Confirm] [] + [-ODataQuery ] [-Force] [-ApiVersion ] [-Pre] [-DefaultProfile ] + [-InformationAction ] [-InformationVariable ] [-WhatIf] [-Confirm] + [] ``` ### Resource that resides at the subscription level. @@ -24,8 +26,8 @@ Invoke-AzureRmResourceAction [-Parameters ] -Action -Resourc Invoke-AzureRmResourceAction [-Parameters ] -Action -ResourceName -ResourceType [-ExtensionResourceName ] [-ExtensionResourceType ] [-ODataQuery ] [-ResourceGroupName ] [-Force] [-ApiVersion ] [-Pre] - [-InformationAction ] [-InformationVariable ] [-WhatIf] [-Confirm] - [] + [-DefaultProfile ] [-InformationAction ] + [-InformationVariable ] [-WhatIf] [-Confirm] [] ``` ### Resource that resides at the tenant level. @@ -33,8 +35,8 @@ Invoke-AzureRmResourceAction [-Parameters ] -Action -Resourc Invoke-AzureRmResourceAction [-Parameters ] -Action -ResourceName -ResourceType [-ExtensionResourceName ] [-ExtensionResourceType ] [-ODataQuery ] [-TenantLevel] [-Force] [-ApiVersion ] [-Pre] - [-InformationAction ] [-InformationVariable ] [-WhatIf] [-Confirm] - [] + [-DefaultProfile ] [-InformationAction ] + [-InformationVariable ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -82,6 +84,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExtensionResourceName Specifies the name of an extension resource for the resource on which this cmdlet invokes an action. For instance, to specify a database, use the following format: diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Move-AzureRmResource.md b/src/ResourceManager/Resources/Commands.Resources/help/Move-AzureRmResource.md index 64791b8c71bc..b01e4e5b2aaa 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Move-AzureRmResource.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Move-AzureRmResource.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 60BED40A-EEA4-4667-93E9-8A9B35037726 online version: schema: 2.0.0 @@ -14,8 +15,9 @@ Moves a resource to a different resource group or subscription. ``` Move-AzureRmResource -DestinationResourceGroupName [-DestinationSubscriptionId ] - -ResourceId [-Force] [-ApiVersion ] [-Pre] [-InformationAction ] - [-InformationVariable ] [-WhatIf] [-Confirm] [] + -ResourceId [-Force] [-ApiVersion ] [-Pre] [-DefaultProfile ] + [-InformationAction ] [-InformationVariable ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -53,6 +55,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DestinationResourceGroupName Specifies the name of the resource group into which this cmdlet moves resources. @@ -204,7 +221,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### String[] - Parameter 'ResourceId' accepts value of type 'String[]' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADAppCredential.md b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADAppCredential.md index 5505187a55e3..65eca23da282 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADAppCredential.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADAppCredential.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 98836BC0-AB4F-4F24-88BE-E7DD350B71E8 online version: schema: 2.0.0 @@ -15,25 +16,25 @@ Adds a credential to an existing application. ### ApplicationObjectIdWithPasswordParameterSet (Default) ``` New-AzureRmADAppCredential -ObjectId -Password [-StartDate ] [-EndDate ] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ApplicationObjectIdWithCertValueParameterSet ``` New-AzureRmADAppCredential -ObjectId -CertValue [-StartDate ] [-EndDate ] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ApplicationIdWithCertValueParameterSet ``` New-AzureRmADAppCredential -ApplicationId -CertValue [-StartDate ] - [-EndDate ] [-WhatIf] [-Confirm] [] + [-EndDate ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ApplicationIdWithPasswordParameterSet ``` New-AzureRmADAppCredential -ApplicationId -Password [-StartDate ] - [-EndDate ] [-WhatIf] [-Confirm] [] + [-EndDate ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -104,6 +105,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EndDate The effective end date of the credential usage. The default end date value is one year from today. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADApplication.md b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADApplication.md index e13b3320e2f5..b543c71d09c2 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADApplication.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADApplication.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: F58FD77E-2946-44B1-B410-6E983FC20E21 online version: schema: 2.0.0 @@ -15,35 +16,36 @@ Creates a new azure active directory application. ### ApplicationWithoutCredentialParameterSet (Default) ``` New-AzureRmADApplication -DisplayName -IdentifierUris [-HomePage ] - [-ReplyUrls ] [-AvailableToOtherTenants ] [-WhatIf] [-Confirm] [] + [-ReplyUrls ] [-AvailableToOtherTenants ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ### ApplicationWithPasswordPlainParameterSet ``` New-AzureRmADApplication -DisplayName -IdentifierUris [-HomePage ] [-ReplyUrls ] [-AvailableToOtherTenants ] -Password [-StartDate ] - [-EndDate ] [-WhatIf] [-Confirm] [] + [-EndDate ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ApplicationWithPasswordCredentialParameterSet ``` New-AzureRmADApplication -DisplayName -IdentifierUris [-HomePage ] [-ReplyUrls ] [-AvailableToOtherTenants ] -PasswordCredentials - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ApplicationWithKeyPlainParameterSet ``` New-AzureRmADApplication -DisplayName -IdentifierUris [-HomePage ] [-ReplyUrls ] [-AvailableToOtherTenants ] -CertValue [-StartDate ] - [-EndDate ] [-WhatIf] [-Confirm] [] + [-EndDate ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ApplicationWithKeyCredentialParameterSet ``` New-AzureRmADApplication -DisplayName -IdentifierUris [-HomePage ] - [-ReplyUrls ] [-AvailableToOtherTenants ] -KeyCredentials [-WhatIf] - [-Confirm] [] + [-ReplyUrls ] [-AvailableToOtherTenants ] -KeyCredentials + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -99,6 +101,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DisplayName Display name of the new application. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADServicePrincipal.md b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADServicePrincipal.md index c1ff5138ba8f..71b78c0c1c87 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADServicePrincipal.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADServicePrincipal.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: D602F910-B26F-473D-B5B6-C7BDFB0A14CB online version: schema: 2.0.0 @@ -14,60 +15,62 @@ Creates a new azure active directory service principal. ### ApplicationWithoutCredentialParameterSet (Default) ``` -New-AzureRmADServicePrincipal -ApplicationId [-WhatIf] [-Confirm] [] +New-AzureRmADServicePrincipal -ApplicationId [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ### ApplicationWithPasswordPlainParameterSet ``` New-AzureRmADServicePrincipal -ApplicationId -Password [-StartDate ] - [-EndDate ] [-WhatIf] [-Confirm] [] + [-EndDate ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ApplicationWithPasswordCredentialParameterSet ``` -New-AzureRmADServicePrincipal -ApplicationId -PasswordCredentials [-WhatIf] - [-Confirm] [] +New-AzureRmADServicePrincipal -ApplicationId -PasswordCredentials + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ApplicationWithKeyPlainParameterSet ``` New-AzureRmADServicePrincipal -ApplicationId -CertValue [-StartDate ] - [-EndDate ] [-WhatIf] [-Confirm] [] + [-EndDate ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ApplicationWithKeyCredentialParameterSet ``` -New-AzureRmADServicePrincipal -ApplicationId -KeyCredentials [-WhatIf] [-Confirm] - [] +New-AzureRmADServicePrincipal -ApplicationId -KeyCredentials + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### DisplayNameWithoutCredentialParameterSet ``` -New-AzureRmADServicePrincipal -DisplayName [-WhatIf] [-Confirm] [] +New-AzureRmADServicePrincipal -DisplayName [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ### DisplayNameWithPasswordPlainParameterSet ``` New-AzureRmADServicePrincipal -DisplayName -Password [-StartDate ] - [-EndDate ] [-WhatIf] [-Confirm] [] + [-EndDate ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### DisplayNameWithPasswordCredentialParameterSet ``` -New-AzureRmADServicePrincipal -DisplayName -PasswordCredentials [-WhatIf] - [-Confirm] [] +New-AzureRmADServicePrincipal -DisplayName -PasswordCredentials + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### DisplayNameWithKeyPlainParameterSet ``` New-AzureRmADServicePrincipal -DisplayName -CertValue [-StartDate ] - [-EndDate ] [-WhatIf] [-Confirm] [] + [-EndDate ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### DisplayNameWithKeyCredentialParameterSet ``` -New-AzureRmADServicePrincipal -DisplayName -KeyCredentials [-WhatIf] [-Confirm] - [] +New-AzureRmADServicePrincipal -DisplayName -KeyCredentials + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -136,6 +139,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DisplayName The friendly name of the service principal. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADSpCredential.md b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADSpCredential.md index ee7eac310f5b..6883f7ca018b 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADSpCredential.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADSpCredential.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 063BAA79-484D-48CF-9170-3808813752BD online version: schema: 2.0.0 @@ -15,25 +16,25 @@ Adds a credential to an existing service principal. ### SpObjectIdWithPasswordParameterSet (Default) ``` New-AzureRmADSpCredential -ObjectId -Password [-StartDate ] [-EndDate ] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### SpObjectIdWithCertValueParameterSet ``` New-AzureRmADSpCredential -ObjectId -CertValue [-StartDate ] [-EndDate ] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### SPNWithCertValueParameterSet ``` New-AzureRmADSpCredential -ServicePrincipalName -CertValue [-StartDate ] - [-EndDate ] [-WhatIf] [-Confirm] [] + [-EndDate ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### SPNWithPasswordParameterSet ``` New-AzureRmADSpCredential -ServicePrincipalName -Password [-StartDate ] - [-EndDate ] [-WhatIf] [-Confirm] [] + [-EndDate ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -73,6 +74,8 @@ In this example, the supplied base64 encoded public X509 certificate ("myapp.cer + + ``` PS E:\> New-AzureRmADSpCredential -ServicePrincipalName "http://test123" -CertValue $credValue ``` @@ -95,6 +98,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EndDate The effective end date of the credential usage. The default end date value is one year from today. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADUser.md b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADUser.md index 3ed7f981ea9a..2afc88d247e7 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADUser.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmADUser.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 86D8965D-D999-48A4-A4EE-9E054E5486EE online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Creates a new active directory user. ``` New-AzureRmADUser -DisplayName -UserPrincipalName -Password [-ImmutableId ] - [-ForceChangePasswordNextLogin] [-WhatIf] [-Confirm] [] + [-ForceChangePasswordNextLogin] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -32,6 +34,21 @@ PS C:\> {{ Add example code here }} ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DisplayName The name to display in the address book for the user. example 'Alex Wu'. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmManagedApplication.md b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmManagedApplication.md index c76d8ee57277..9219fe119f5d 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmManagedApplication.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmManagedApplication.md @@ -16,7 +16,7 @@ Creates an Azure managed application. New-AzureRmManagedApplication -Name -ResourceGroupName -ManagedResourceGroupName [-ManagedApplicationDefinitionId ] -Location [-Parameter ] -Kind [-Plan ] [-Tag ] [-ApiVersion ] [-Pre] - [-DefaultProfile ] [-WhatIf] [-Confirm] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -248,17 +248,18 @@ 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 System.Collections.Hashtable - ## OUTPUTS ### System.Management.Automation.PSObject - ## NOTES ## RELATED LINKS diff --git a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmManagedApplicationDefinition.md b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmManagedApplicationDefinition.md index 08f59607f0eb..06dece3a00c5 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmManagedApplicationDefinition.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmManagedApplicationDefinition.md @@ -15,8 +15,9 @@ Creates a managed application definition. ``` New-AzureRmManagedApplicationDefinition -Name -ResourceGroupName -DisplayName -Description -Location -LockLevel [-PackageFileUri ] - -Authorization [-Tag ] [-ApiVersion ] [-Pre] - [-DefaultProfile ] [-WhatIf] [-Confirm] + [-CreateUiDefinition ] [-MainTemplate ] -Authorization [-Tag ] + [-ApiVersion ] [-Pre] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -65,6 +66,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -CreateUiDefinition +The managed application definition create ui definition + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -DefaultProfile The credentials, account, tenant, and subscription used for communication with azure. @@ -141,6 +157,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -MainTemplate +The managed application definition main template + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -Name The managed application definition name. @@ -247,6 +278,9 @@ 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 @@ -254,12 +288,10 @@ Microsoft.Azure.Commands.ResourceManager.Cmdlets.Entities.Application.Applicatio System.String[] System.Collections.Hashtable - ## OUTPUTS ### System.Management.Automation.PSObject - ## NOTES ## RELATED LINKS diff --git a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmPolicyAssignment.md b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmPolicyAssignment.md index d3d6a365da2c..a2b01b1838d9 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmPolicyAssignment.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmPolicyAssignment.md @@ -16,38 +16,45 @@ Creates a policy assignment. ### Policy assignment without parameters (Default) ``` New-AzureRmPolicyAssignment -Name -Scope [-NotScope ] [-DisplayName ] - [-PolicyDefinition ] [-PolicySetDefinition ] [-ApiVersion ] [-Pre] + [-Description ] [-PolicyDefinition ] [-PolicySetDefinition ] [-Sku ] + [-ApiVersion ] [-Pre] [-DefaultProfile ] [-InformationAction ] [-InformationVariable ] [] ``` ### Policy assignment with parameters via policy parameter object ``` New-AzureRmPolicyAssignment -Name -Scope [-NotScope ] [-DisplayName ] - -PolicyDefinition [-PolicySetDefinition ] -PolicyParameterObject - [-ApiVersion ] [-Pre] [-InformationAction ] [-InformationVariable ] - [] + [-Description ] -PolicyDefinition [-PolicySetDefinition ] + -PolicyParameterObject [-Sku ] [-ApiVersion ] [-Pre] + [-DefaultProfile ] [-InformationAction ] + [-InformationVariable ] [] ``` ### Policy assignment with parameters via policy parameter string ``` New-AzureRmPolicyAssignment -Name -Scope [-NotScope ] [-DisplayName ] - -PolicyDefinition [-PolicySetDefinition ] -PolicyParameter - [-ApiVersion ] [-Pre] [-InformationAction ] [-InformationVariable ] - [] + [-Description ] -PolicyDefinition [-PolicySetDefinition ] + -PolicyParameter [-Sku ] [-ApiVersion ] [-Pre] + [-DefaultProfile ] [-InformationAction ] + [-InformationVariable ] [] ``` ### Policy assignment with parameters via policy set parameter object ``` New-AzureRmPolicyAssignment -Name -Scope [-NotScope ] [-DisplayName ] - [-PolicyDefinition ] -PolicySetDefinition [-ApiVersion ] [-Pre] - [-InformationAction ] [-InformationVariable ] [] + [-Description ] [-PolicyDefinition ] -PolicySetDefinition + -PolicyParameterObject [-Sku ] [-ApiVersion ] [-Pre] + [-DefaultProfile ] [-InformationAction ] + [-InformationVariable ] [] ``` ### Policy assignment with parameters via policy set parameter string ``` New-AzureRmPolicyAssignment -Name -Scope [-NotScope ] [-DisplayName ] - [-PolicyDefinition ] -PolicySetDefinition [-ApiVersion ] [-Pre] - [-InformationAction ] [-InformationVariable ] [] + [-Description ] [-PolicyDefinition ] -PolicySetDefinition + -PolicyParameter [-Sku ] [-ApiVersion ] [-Pre] + [-DefaultProfile ] [-InformationAction ] + [-InformationVariable ] [] ``` ## DESCRIPTION @@ -90,6 +97,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description for policy assignment + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -DisplayName Specifies a display name for the policy assignment. @@ -206,7 +243,7 @@ The policy parameter file path or policy parameter string. ```yaml Type: String -Parameter Sets: Policy assignment with parameters via policy parameter string +Parameter Sets: Policy assignment with parameters via policy parameter string, Policy assignment with parameters via policy set parameter string Aliases: Required: True @@ -221,7 +258,7 @@ The policy parameter object. ```yaml Type: Hashtable -Parameter Sets: Policy assignment with parameters via policy parameter object +Parameter Sets: Policy assignment with parameters via policy parameter object, Policy assignment with parameters via policy set parameter object Aliases: Required: True @@ -291,6 +328,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Sku +A hash table which represents sku properties. Defaults to Free Sku: Name = A0, Tier = Fre + +```yaml +Type: Hashtable +Parameter Sets: (All) +Aliases: SkuObject + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +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). diff --git a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmPolicyDefinition.md b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmPolicyDefinition.md index fae062e7521e..85ddc5153678 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmPolicyDefinition.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmPolicyDefinition.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 31F2AF24-488D-4CAF-A9C8-C8DAE76E031F online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Creates a policy definition. ``` New-AzureRmPolicyDefinition -Name [-DisplayName ] [-Description ] -Policy - [-Parameter ] [-ApiVersion ] [-Pre] [-InformationAction ] + [-Metadata ] [-Parameter ] [-Mode ] [-ApiVersion ] [-Pre] + [-DefaultProfile ] [-InformationAction ] [-InformationVariable ] [] ``` @@ -56,6 +58,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Description Specifies a description for the policy definition. @@ -125,6 +142,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Metadata +The metadata for policy definition. This can either be a path to a file name containing the metadata, or the metadata as string + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Mode +The mode of the policy definition + +```yaml +Type: PolicyDefinitionMode +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -Name Specifies a name for the policy definition. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmPolicySetDefinition.md b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmPolicySetDefinition.md index 3ef22b043626..a34c1078e5db 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmPolicySetDefinition.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmPolicySetDefinition.md @@ -14,7 +14,8 @@ Creates a policy set definition. ``` New-AzureRmPolicySetDefinition -Name [-DisplayName ] [-Description ] - -PolicyDefinition [-Parameter ] [-ApiVersion ] [-Pre] [] + [-Metadata ] -PolicyDefinition [-Parameter ] [-ApiVersion ] [-Pre] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -47,6 +48,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Description The description for policy set definition. @@ -77,6 +93,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Metadata +The metadata for policy set definition. This can either be a path to a file name containing the metadata, or the metadata as string + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -Name The policy set definition name. @@ -138,6 +169,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: 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: 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). diff --git a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmResource.md b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmResource.md index b0aefd613de2..150130808a18 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmResource.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmResource.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: D6FF6BDD-4515-438D-B39D-C0BFC3342F4E -online version: +online version: schema: 2.0.0 --- @@ -16,7 +17,8 @@ Creates a resource. ``` New-AzureRmResource [-Location ] [-Kind ] [-Properties ] [-Plan ] [-Sku ] [-Tag ] [-IsFullObject] -ResourceId [-ODataQuery ] [-Force] - [-ApiVersion ] [-Pre] [-WhatIf] [-Confirm] [] + [-ApiVersion ] [-Pre] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### Resource that resides at the subscription level. @@ -24,7 +26,8 @@ New-AzureRmResource [-Location ] [-Kind ] [-Properties ] [-Kind ] [-Properties ] [-Plan ] [-Sku ] [-Tag ] [-IsFullObject] -ResourceName -ResourceType [-ExtensionResourceName ] [-ExtensionResourceType ] [-ODataQuery ] - [-ResourceGroupName ] [-Force] [-ApiVersion ] [-Pre] [-WhatIf] [-Confirm] [] + [-ResourceGroupName ] [-Force] [-ApiVersion ] [-Pre] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### Resource that resides at the tenant level. @@ -32,7 +35,8 @@ New-AzureRmResource [-Location ] [-Kind ] [-Properties ] [-Kind ] [-Properties ] [-Plan ] [-Sku ] [-Tag ] [-IsFullObject] -ResourceName -ResourceType [-ExtensionResourceName ] [-ExtensionResourceType ] [-ODataQuery ] [-TenantLevel] - [-Force] [-ApiVersion ] [-Pre] [-WhatIf] [-Confirm] [] + [-Force] [-ApiVersion ] [-Pre] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -71,7 +75,22 @@ Specifies the version of the resource provider API to use. If you do not specify ```yaml Type: String Parameter Sets: (All) -Aliases: +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: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential Required: False Position: Named @@ -88,7 +107,7 @@ server name`/`database name ```yaml Type: String Parameter Sets: Resource that resides at the subscription level., Resource that resides at the tenant level. -Aliases: +Aliases: Required: False Position: Named @@ -106,7 +125,7 @@ For instance, if the extension resource is a database, specify the following typ ```yaml Type: String Parameter Sets: Resource that resides at the subscription level., Resource that resides at the tenant level. -Aliases: +Aliases: Required: False Position: Named @@ -121,7 +140,7 @@ Forces the command to run without asking for user confirmation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -136,7 +155,7 @@ Indicates that the object that the *Properties* parameter specifies is the full ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -151,7 +170,7 @@ Specifies the resource kind for the resource. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -171,7 +190,7 @@ type, use the Get-AzureLocation cmdlet. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -187,7 +206,7 @@ in addition to any other filters. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -217,7 +236,7 @@ Indicates that this cmdlet considers pre-release API versions when it automatica ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -248,7 +267,7 @@ Specifies the name of the resource group where this cmdlet creates the resource. ```yaml Type: String Parameter Sets: Resource that resides at the subscription level. -Aliases: +Aliases: Required: False Position: Named @@ -300,7 +319,7 @@ For instance, for a database, the resource type is as follows: ```yaml Type: String Parameter Sets: Resource that resides at the subscription level., Resource that resides at the tenant level. -Aliases: +Aliases: Required: True Position: Named @@ -347,7 +366,7 @@ Indicates that this cmdlet operates at the tenant level. ```yaml Type: SwitchParameter Parameter Sets: Resource that resides at the tenant level. -Aliases: +Aliases: Required: True Position: Named diff --git a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmResourceGroup.md b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmResourceGroup.md index 33b5dd32a564..5865171e27ad 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmResourceGroup.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmResourceGroup.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 0632DAD6-F331-454F-9E7E-2164AB413E77 -online version: +online version: schema: 2.0.0 --- @@ -14,7 +15,7 @@ Creates an Azure resource group. ``` New-AzureRmResourceGroup -Name -Location [-Tag ] [-Force] [-ApiVersion ] - [-Pre] [-WhatIf] [-Confirm] [] + [-Pre] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -66,7 +67,22 @@ You can specify a different version than the default version. ```yaml Type: String Parameter Sets: (All) -Aliases: +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: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential Required: False Position: Named @@ -81,7 +97,7 @@ Forces the command to run without asking for user confirmation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -101,7 +117,7 @@ with the *ProviderNamespace* parameter. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -133,7 +149,7 @@ Indicates that this cmdlet considers pre-release API versions when it automatica ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named diff --git a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmResourceGroupDeployment.md b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmResourceGroupDeployment.md index 6f6e0355a147..d48393504024 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmResourceGroupDeployment.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmResourceGroupDeployment.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 6E2F0D5E-E683-46F3-B48B-55C4864F3308 online version: schema: 2.0.0 @@ -15,57 +16,63 @@ Adds an Azure deployment to a resource group. ### Deployment via template file without parameters (Default) ``` New-AzureRmResourceGroupDeployment [-Name ] -ResourceGroupName [-Mode ] - [-DeploymentDebugLogLevel ] [-Force] -TemplateFile [-ApiVersion ] [-Pre] [-WhatIf] - [-Confirm] [] + [-DeploymentDebugLogLevel ] [-Force] -TemplateFile [-ApiVersion ] [-Pre] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### Deployment via template file and template parameters object ``` New-AzureRmResourceGroupDeployment [-Name ] -ResourceGroupName [-Mode ] [-DeploymentDebugLogLevel ] [-Force] -TemplateParameterObject -TemplateFile - [-ApiVersion ] [-Pre] [-WhatIf] [-Confirm] [] + [-ApiVersion ] [-Pre] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### Deployment via template uri and template parameters object ``` New-AzureRmResourceGroupDeployment [-Name ] -ResourceGroupName [-Mode ] [-DeploymentDebugLogLevel ] [-Force] -TemplateParameterObject -TemplateUri - [-ApiVersion ] [-Pre] [-WhatIf] [-Confirm] [] + [-ApiVersion ] [-Pre] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### Deployment via template file and template parameters file ``` New-AzureRmResourceGroupDeployment [-Name ] -ResourceGroupName [-Mode ] [-DeploymentDebugLogLevel ] [-Force] -TemplateParameterFile -TemplateFile - [-ApiVersion ] [-Pre] [-WhatIf] [-Confirm] [] + [-ApiVersion ] [-Pre] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### Deployment via template uri and template parameters file ``` New-AzureRmResourceGroupDeployment [-Name ] -ResourceGroupName [-Mode ] [-DeploymentDebugLogLevel ] [-Force] -TemplateParameterFile -TemplateUri - [-ApiVersion ] [-Pre] [-WhatIf] [-Confirm] [] + [-ApiVersion ] [-Pre] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### Deployment via template file template parameters uri ``` New-AzureRmResourceGroupDeployment [-Name ] -ResourceGroupName [-Mode ] [-DeploymentDebugLogLevel ] [-Force] -TemplateParameterUri -TemplateFile - [-ApiVersion ] [-Pre] [-WhatIf] [-Confirm] [] + [-ApiVersion ] [-Pre] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### Deployment via template uri and template parameters uri ``` New-AzureRmResourceGroupDeployment [-Name ] -ResourceGroupName [-Mode ] [-DeploymentDebugLogLevel ] [-Force] -TemplateParameterUri -TemplateUri - [-ApiVersion ] [-Pre] [-WhatIf] [-Confirm] [] + [-ApiVersion ] [-Pre] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### Deployment via template uri without parameters ``` New-AzureRmResourceGroupDeployment [-Name ] -ResourceGroupName [-Mode ] - [-DeploymentDebugLogLevel ] [-Force] -TemplateUri [-ApiVersion ] [-Pre] [-WhatIf] - [-Confirm] [] + [-DeploymentDebugLogLevel ] [-Force] -TemplateUri [-ApiVersion ] [-Pre] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -119,6 +126,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DeploymentDebugLogLevel Specifies a debug log level. The acceptable values for this parameter are: diff --git a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmResourceLock.md b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmResourceLock.md index 72306de002dd..0e50f6ae2170 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmResourceLock.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmResourceLock.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 6847ECFD-2E3D-46F6-ABE9-9D8E08C7858F online version: schema: 2.0.0 @@ -15,53 +16,57 @@ Creates a resource lock. ### A lock at the specified scope. (Default) ``` New-AzureRmResourceLock -LockName -LockLevel [-LockNotes ] [-Force] - -Scope [-ApiVersion ] [-Pre] [-InformationAction ] - [-InformationVariable ] [-WhatIf] [-Confirm] [] + -Scope [-ApiVersion ] [-Pre] [-DefaultProfile ] + [-InformationAction ] [-InformationVariable ] [-WhatIf] [-Confirm] + [] ``` ### A lock at the resource group scope. ``` New-AzureRmResourceLock -LockName -LockLevel [-LockNotes ] [-Force] - -ResourceGroupName [-ApiVersion ] [-Pre] [-InformationAction ] - [-InformationVariable ] [-WhatIf] [-Confirm] [] + -ResourceGroupName [-ApiVersion ] [-Pre] [-DefaultProfile ] + [-InformationAction ] [-InformationVariable ] [-WhatIf] [-Confirm] + [] ``` ### A lock at the resource group resource scope. ``` New-AzureRmResourceLock -LockName -LockLevel [-LockNotes ] [-Force] -ResourceName -ResourceType -ResourceGroupName [-ApiVersion ] [-Pre] - [-InformationAction ] [-InformationVariable ] [-WhatIf] [-Confirm] - [] + [-DefaultProfile ] [-InformationAction ] + [-InformationVariable ] [-WhatIf] [-Confirm] [] ``` ### A lock at the subscription scope. ``` New-AzureRmResourceLock -LockName -LockLevel [-LockNotes ] [-Force] - [-ApiVersion ] [-Pre] [-InformationAction ] [-InformationVariable ] - [-WhatIf] [-Confirm] [] + [-ApiVersion ] [-Pre] [-DefaultProfile ] + [-InformationAction ] [-InformationVariable ] [-WhatIf] [-Confirm] + [] ``` ### A lock at the subscription resource scope. ``` New-AzureRmResourceLock -LockName -LockLevel [-LockNotes ] [-Force] -ResourceName -ResourceType [-ApiVersion ] [-Pre] - [-InformationAction ] [-InformationVariable ] [-WhatIf] [-Confirm] - [] + [-DefaultProfile ] [-InformationAction ] + [-InformationVariable ] [-WhatIf] [-Confirm] [] ``` ### A lock at the tenant resource scope. ``` New-AzureRmResourceLock -LockName -LockLevel [-LockNotes ] [-Force] -ResourceName -ResourceType [-TenantLevel] [-ApiVersion ] [-Pre] - [-InformationAction ] [-InformationVariable ] [-WhatIf] [-Confirm] - [] + [-DefaultProfile ] [-InformationAction ] + [-InformationVariable ] [-WhatIf] [-Confirm] [] ``` ### A lock, by Id. ``` New-AzureRmResourceLock -LockLevel [-LockNotes ] [-Force] -LockId - [-ApiVersion ] [-Pre] [-InformationAction ] [-InformationVariable ] - [-WhatIf] [-Confirm] [] + [-ApiVersion ] [-Pre] [-DefaultProfile ] + [-InformationAction ] [-InformationVariable ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -94,6 +99,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmRoleAssignment.md b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmRoleAssignment.md index 1da1b37baa57..92330e56dee3 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmRoleAssignment.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmRoleAssignment.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: E460D108-2BF9-4F57-AF3D-13868DC73EA0 online version: schema: 2.0.0 @@ -14,65 +15,71 @@ Assigns the specified RBAC role to the specified principal, at the specified sco ### EmptyParameterSet (Default) ``` -New-AzureRmRoleAssignment -ObjectId -Scope -RoleDefinitionName [] +New-AzureRmRoleAssignment -ObjectId -Scope -RoleDefinitionName + [-DefaultProfile ] [] ``` ### ResourceGroupWithObjectIdParameterSet ``` New-AzureRmRoleAssignment -ObjectId -ResourceGroupName -RoleDefinitionName - [] + [-DefaultProfile ] [] ``` ### ResourceWithObjectIdParameterSet ``` New-AzureRmRoleAssignment -ObjectId -ResourceGroupName -ResourceName - -ResourceType [-ParentResource ] -RoleDefinitionName [] + -ResourceType [-ParentResource ] -RoleDefinitionName + [-DefaultProfile ] [] ``` ### ScopeWithObjectIdParameterSet ``` -New-AzureRmRoleAssignment -ObjectId [-Scope ] -RoleDefinitionName [] +New-AzureRmRoleAssignment -ObjectId [-Scope ] -RoleDefinitionName + [-DefaultProfile ] [] ``` ### RoleIdWithScopeAndObjectIdParameterSet ``` -New-AzureRmRoleAssignment -ObjectId -Scope -RoleDefinitionId [] +New-AzureRmRoleAssignment -ObjectId -Scope -RoleDefinitionId + [-DefaultProfile ] [] ``` ### ResourceGroupWithSignInNameParameterSet ``` New-AzureRmRoleAssignment -SignInName -ResourceGroupName -RoleDefinitionName - [] + [-DefaultProfile ] [] ``` ### ResourceWithSignInNameParameterSet ``` New-AzureRmRoleAssignment -SignInName -ResourceGroupName -ResourceName - -ResourceType [-ParentResource ] -RoleDefinitionName [] + -ResourceType [-ParentResource ] -RoleDefinitionName + [-DefaultProfile ] [] ``` ### ScopeWithSignInNameParameterSet ``` New-AzureRmRoleAssignment -SignInName [-Scope ] -RoleDefinitionName - [] + [-DefaultProfile ] [] ``` ### ResourceGroupWithSPNParameterSet ``` New-AzureRmRoleAssignment -ServicePrincipalName -ResourceGroupName - -RoleDefinitionName [] + -RoleDefinitionName [-DefaultProfile ] [] ``` ### ResourceWithSPNParameterSet ``` New-AzureRmRoleAssignment -ServicePrincipalName -ResourceGroupName -ResourceName - -ResourceType [-ParentResource ] -RoleDefinitionName [] + -ResourceType [-ParentResource ] -RoleDefinitionName + [-DefaultProfile ] [] ``` ### ScopeWithSPNParameterSet ``` New-AzureRmRoleAssignment -ServicePrincipalName [-Scope ] -RoleDefinitionName - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -136,6 +143,21 @@ Grant access to a group at a nested resource (subnet) ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ObjectId Azure AD Objectid of the user, group or service principal. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmRoleDefinition.md b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmRoleDefinition.md index 5c75e6607892..37fdf6c8108f 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmRoleDefinition.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/New-AzureRmRoleDefinition.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 8300B143-E322-419E-BC98-DBA56DD90A59 online version: schema: 2.0.0 @@ -18,12 +19,13 @@ Finally, use this command to create a custom role using role definition. ### InputFileParameterSet ``` -New-AzureRmRoleDefinition [-InputFile] [] +New-AzureRmRoleDefinition [-InputFile] [-DefaultProfile ] [] ``` ### RoleDefinitionParameterSet ``` -New-AzureRmRoleDefinition [-Role] [] +New-AzureRmRoleDefinition [-Role] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -111,6 +113,21 @@ PS C:\> New-AzureRmRoleDefinition -InputFile C:\Temp\roleDefinition.json ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InputFile File name containing a single json role definition. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Register-AzureRmProviderFeature.md b/src/ResourceManager/Resources/Commands.Resources/help/Register-AzureRmProviderFeature.md index ba024825200d..a535445c4e86 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Register-AzureRmProviderFeature.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Register-AzureRmProviderFeature.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 83EE33E5-18EF-4A7A-AEF2-E93D7A3CA541 online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Registers an Azure provider feature in your account. ## SYNTAX ``` -Register-AzureRmProviderFeature -FeatureName -ProviderNamespace [-WhatIf] [-Confirm] - [] +Register-AzureRmProviderFeature -FeatureName -ProviderNamespace + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -29,6 +30,21 @@ The **Register-AzureRmProviderFeature** cmdlet registers an Azure provider featu ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -FeatureName Specifies the name of the feature that this cmdlet registers. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Register-AzureRmResourceProvider.md b/src/ResourceManager/Resources/Commands.Resources/help/Register-AzureRmResourceProvider.md index 77d39c8831e1..a070fe026682 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Register-AzureRmResourceProvider.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Register-AzureRmResourceProvider.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: D5067FD8-2FB1-413C-9F59-84E83A74343E online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Registers a resource provider. ## SYNTAX ``` -Register-AzureRmResourceProvider -ProviderNamespace [-ApiVersion ] [-Pre] [-WhatIf] [-Confirm] - [] +Register-AzureRmResourceProvider -ProviderNamespace [-ApiVersion ] [-Pre] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,6 +46,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Pre Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADAppCredential.md b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADAppCredential.md index 6f37023f2ce0..278fa8489ec5 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADAppCredential.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADAppCredential.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: C61FA834-BEBE-4DBF-888F-C6CB8CC95390 online version: schema: 2.0.0 @@ -14,24 +15,26 @@ Removes a credential from an application. ### ApplicationObjectIdWithKeyIdParameterSet (Default) ``` -Remove-AzureRmADAppCredential -ObjectId -KeyId [-Force] [-WhatIf] [-Confirm] - [] +Remove-AzureRmADAppCredential -ObjectId -KeyId [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ApplicationObjectIdWithAllParameterSet ``` -Remove-AzureRmADAppCredential -ObjectId [-All] [-Force] [-WhatIf] [-Confirm] [] +Remove-AzureRmADAppCredential -ObjectId [-All] [-Force] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ### ApplicationIdWithKeyIdParameterSet ``` -Remove-AzureRmADAppCredential -ApplicationId -KeyId [-Force] [-WhatIf] [-Confirm] - [] +Remove-AzureRmADAppCredential -ApplicationId -KeyId [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ApplicationIdWithAllParameterSet ``` -Remove-AzureRmADAppCredential -ApplicationId [-All] [-Force] [-WhatIf] [-Confirm] [] +Remove-AzureRmADAppCredential -ApplicationId [-All] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -89,6 +92,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Switch to delete credential without a confirmation. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADApplication.md b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADApplication.md index d3bb705f0394..86e7d1e796cb 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADApplication.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADApplication.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: C791C593-F7D5-4961-97F9-E4909813FFE7 online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Deletes the azure active directory application. ## SYNTAX ``` -Remove-AzureRmADApplication -ObjectId [-Force] [-WhatIf] [-Confirm] [] +Remove-AzureRmADApplication -ObjectId [-Force] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -30,6 +32,21 @@ Deletes the azure active directory application. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Switch to delete an application without a confirmation. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADServicePrincipal.md b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADServicePrincipal.md index d17130ce064f..af4e68d9dd27 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADServicePrincipal.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADServicePrincipal.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 0C8C07CA-6720-452F-A952-48C76EBF3BBD online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Deletes the azure active directory service principal. ## SYNTAX ``` -Remove-AzureRmADServicePrincipal -ObjectId [-PassThru] [-Force] [-WhatIf] [-Confirm] - [] +Remove-AzureRmADServicePrincipal -ObjectId [-PassThru] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -31,6 +32,21 @@ Deletes the given azure active directory service principal. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force {{Fill Force Description}} diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADSpCredential.md b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADSpCredential.md index f55d47473231..f442e1044095 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADSpCredential.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADSpCredential.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 04B1E3A6-6D52-46A3-8241-2CCDB5E71642 online version: schema: 2.0.0 @@ -14,25 +15,26 @@ Removes a credential from a service principal. ### ObjectIdWithKeyIdParameterSet (Default) ``` -Remove-AzureRmADSpCredential -ObjectId -KeyId [-Force] [-WhatIf] [-Confirm] - [] +Remove-AzureRmADSpCredential -ObjectId -KeyId [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ObjectIdWithAllParameterSet ``` -Remove-AzureRmADSpCredential -ObjectId [-All] [-Force] [-WhatIf] [-Confirm] [] +Remove-AzureRmADSpCredential -ObjectId [-All] [-Force] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ### SPNWithKeyIdParameterSet ``` -Remove-AzureRmADSpCredential -ServicePrincipalName -KeyId [-Force] [-WhatIf] [-Confirm] - [] +Remove-AzureRmADSpCredential -ServicePrincipalName -KeyId [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### SPNWithAllParameterSet ``` -Remove-AzureRmADSpCredential -ServicePrincipalName [-All] [-Force] [-WhatIf] [-Confirm] - [] +Remove-AzureRmADSpCredential -ServicePrincipalName [-All] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -76,6 +78,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Switch to delete credential without a confirmation. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADUser.md b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADUser.md index cd571eb0438d..0ee31d0995dd 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADUser.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmADUser.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 9F9B2691-BB3F-4644-BD95-6D74777D1E99 online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Deletes an active directory user. ## SYNTAX ``` -Remove-AzureRmADUser -UPNOrObjectId [-Force] [-WhatIf] [-Confirm] [] +Remove-AzureRmADUser -UPNOrObjectId [-Force] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -30,6 +32,21 @@ PS C:\> {{ Add example code here }} ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force If specified, doesn't ask for confirmation for deleting user. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmManagedApplication.md b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmManagedApplication.md index a5565a05192e..44fdb4befb90 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmManagedApplication.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmManagedApplication.md @@ -15,13 +15,13 @@ Removes a managed application ### The managed application name parameter set. (Default) ``` Remove-AzureRmManagedApplication -Name -ResourceGroupName [-Force] [-ApiVersion ] - [-Pre] [-DefaultProfile ] [-WhatIf] [-Confirm] + [-Pre] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### The managed application Id parameter set. ``` Remove-AzureRmManagedApplication -Id [-Force] [-ApiVersion ] [-Pre] - [-DefaultProfile ] [-WhatIf] [-Confirm] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -181,16 +181,17 @@ 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 - ## OUTPUTS ### System.Boolean - ## NOTES ## RELATED LINKS diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmManagedApplicationDefinition.md b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmManagedApplicationDefinition.md index 014c744dae34..ed0932a921c4 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmManagedApplicationDefinition.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmManagedApplicationDefinition.md @@ -16,12 +16,13 @@ Removes a managed application definition ``` Remove-AzureRmManagedApplicationDefinition -Name -ResourceGroupName [-Force] [-ApiVersion ] [-Pre] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### The managed application definition Id parameter set. ``` Remove-AzureRmManagedApplicationDefinition -Id [-Force] [-ApiVersion ] [-Pre] - [-DefaultProfile ] [-WhatIf] [-Confirm] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -181,16 +182,17 @@ 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 - ## OUTPUTS ### System.Boolean - ## NOTES ## RELATED LINKS diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmPolicyAssignment.md b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmPolicyAssignment.md index cd02f8e61251..d960bfb44f0e 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmPolicyAssignment.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmPolicyAssignment.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 36399302-3EA5-45A3-A042-536CC7EC2E6D online version: schema: 2.0.0 @@ -15,15 +16,15 @@ Removes a policy assignment. ### The policy assignment name parameter set. (Default) ``` Remove-AzureRmPolicyAssignment -Name -Scope [-ApiVersion ] [-Pre] - [-InformationAction ] [-InformationVariable ] [-WhatIf] [-Confirm] - [] + [-DefaultProfile ] [-InformationAction ] + [-InformationVariable ] [-WhatIf] [-Confirm] [] ``` ### The policy assignment Id parameter set. ``` Remove-AzureRmPolicyAssignment -Id [-ApiVersion ] [-Pre] - [-InformationAction ] [-InformationVariable ] [-WhatIf] [-Confirm] - [] + [-DefaultProfile ] [-InformationAction ] + [-InformationVariable ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -75,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id Specifies the fully qualified resource ID for the policy assignment that this cmdlet removes. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmPolicyDefinition.md b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmPolicyDefinition.md index 2e01929f46c0..d180b43cb5ef 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmPolicyDefinition.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmPolicyDefinition.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: DEC01722-EB1A-45CE-BD30-9DB861718573 online version: schema: 2.0.0 @@ -15,15 +16,15 @@ Removes a policy definition. ### The policy definition name parameter set. (Default) ``` Remove-AzureRmPolicyDefinition -Name [-Force] [-ApiVersion ] [-Pre] - [-InformationAction ] [-InformationVariable ] [-WhatIf] [-Confirm] - [] + [-DefaultProfile ] [-InformationAction ] + [-InformationVariable ] [-WhatIf] [-Confirm] [] ``` ### The policy definition Id parameter set. ``` Remove-AzureRmPolicyDefinition -Id [-Force] [-ApiVersion ] [-Pre] - [-InformationAction ] [-InformationVariable ] [-WhatIf] [-Confirm] - [] + [-DefaultProfile ] [-InformationAction ] + [-InformationVariable ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -67,6 +68,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmPolicySetDefinition.md b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmPolicySetDefinition.md index 50d99de33ccc..fbba245a93f6 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmPolicySetDefinition.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmPolicySetDefinition.md @@ -14,14 +14,14 @@ Removes a policy set definition. ### The policy set definition name parameter set. (Default) ``` -Remove-AzureRmPolicySetDefinition -Name [-Force] [-ApiVersion ] [-Pre] [-WhatIf] [-Confirm] - [] +Remove-AzureRmPolicySetDefinition -Name [-Force] [-ApiVersion ] [-Pre] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### The policy set definition Id parameter set. ``` -Remove-AzureRmPolicySetDefinition -Id [-Force] [-ApiVersion ] [-Pre] [-WhatIf] [-Confirm] - [] +Remove-AzureRmPolicySetDefinition -Id [-Force] [-ApiVersion ] [-Pre] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -58,6 +58,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Do not ask for confirmation. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmResource.md b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmResource.md index 9d14d4a3b955..d2d48c58bd72 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmResource.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmResource.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: A262DFD1-8B90-462C-A4E2-ABA0F51173FA online version: schema: 2.0.0 @@ -15,21 +16,22 @@ Removes a resource. ### The resource Id. (Default) ``` Remove-AzureRmResource -ResourceId [-ODataQuery ] [-Force] [-ApiVersion ] [-Pre] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### Resource that resides at the subscription level. ``` Remove-AzureRmResource -ResourceName -ResourceType [-ExtensionResourceName ] [-ExtensionResourceType ] [-ODataQuery ] [-ResourceGroupName ] [-Force] - [-ApiVersion ] [-Pre] [-WhatIf] [-Confirm] [] + [-ApiVersion ] [-Pre] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### Resource that resides at the tenant level. ``` Remove-AzureRmResource -ResourceName -ResourceType [-ExtensionResourceName ] [-ExtensionResourceType ] [-ODataQuery ] [-TenantLevel] [-Force] [-ApiVersion ] [-Pre] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -65,6 +67,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExtensionResourceName Specifies the name of an extension resource of the resource that this cmdlet removes. For instance, to specify a database, use the following format: diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmResourceGroup.md b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmResourceGroup.md index 5f2c60b8a002..c679ca3e3a2d 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmResourceGroup.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmResourceGroup.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 880D321E-30F2-4CAE-B14A-5F6DD8E1DB99 online version: schema: 2.0.0 @@ -14,14 +15,14 @@ Removes a resource group. ### Lists the resource group based in the name. (Default) ``` -Remove-AzureRmResourceGroup [-Name] [-Force] [-ApiVersion ] [-Pre] [-WhatIf] [-Confirm] - [] +Remove-AzureRmResourceGroup [-Name] [-Force] [-ApiVersion ] [-Pre] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### Lists the resource group based in the Id. ``` -Remove-AzureRmResourceGroup [-Id] [-Force] [-ApiVersion ] [-Pre] [-WhatIf] [-Confirm] - [] +Remove-AzureRmResourceGroup [-Id] [-Force] [-ApiVersion ] [-Pre] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -71,6 +72,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmResourceGroupDeployment.md b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmResourceGroupDeployment.md index bcc2df4020ad..15a7411505ec 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmResourceGroupDeployment.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmResourceGroupDeployment.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: C3DD193E-B8FE-468D-BEE7-00C3D99B469E online version: schema: 2.0.0 @@ -15,13 +16,13 @@ Removes a resource group deployment and any associated operations. ### The deployment name parameter set. (Default) ``` Remove-AzureRmResourceGroupDeployment -ResourceGroupName -Name [-ApiVersion ] [-Pre] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### The deployment Id parameter set. ``` -Remove-AzureRmResourceGroupDeployment -Id [-ApiVersion ] [-Pre] [-WhatIf] [-Confirm] - [] +Remove-AzureRmResourceGroupDeployment -Id [-ApiVersion ] [-Pre] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -52,6 +53,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id Specifies the ID of the resource group deployment to remove. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmResourceLock.md b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmResourceLock.md index dfbdbb810086..da2866ea1629 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmResourceLock.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmResourceLock.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 42EEAAA8-F13B-486B-82BD-F646EF0DCDBA online version: schema: 2.0.0 @@ -15,50 +16,53 @@ Removes a resource lock. ### A lock, by Id. (Default) ``` Remove-AzureRmResourceLock [-Force] -LockId [-ApiVersion ] [-Pre] - [-InformationAction ] [-InformationVariable ] [-WhatIf] [-Confirm] - [] + [-DefaultProfile ] [-InformationAction ] + [-InformationVariable ] [-WhatIf] [-Confirm] [] ``` ### A lock at the resource group scope. ``` Remove-AzureRmResourceLock -LockName [-Force] -ResourceGroupName [-ApiVersion ] - [-Pre] [-InformationAction ] [-InformationVariable ] [-WhatIf] [-Confirm] - [] + [-Pre] [-DefaultProfile ] [-InformationAction ] + [-InformationVariable ] [-WhatIf] [-Confirm] [] ``` ### A lock at the resource group resource scope. ``` Remove-AzureRmResourceLock -LockName [-Force] -ResourceName -ResourceType - -ResourceGroupName [-ApiVersion ] [-Pre] [-InformationAction ] - [-InformationVariable ] [-WhatIf] [-Confirm] [] + -ResourceGroupName [-ApiVersion ] [-Pre] [-DefaultProfile ] + [-InformationAction ] [-InformationVariable ] [-WhatIf] [-Confirm] + [] ``` ### A lock at the specified scope. ``` Remove-AzureRmResourceLock -LockName [-Force] -Scope [-ApiVersion ] [-Pre] - [-InformationAction ] [-InformationVariable ] [-WhatIf] [-Confirm] - [] + [-DefaultProfile ] [-InformationAction ] + [-InformationVariable ] [-WhatIf] [-Confirm] [] ``` ### A lock at the subscription scope. ``` Remove-AzureRmResourceLock -LockName [-Force] [-ApiVersion ] [-Pre] - [-InformationAction ] [-InformationVariable ] [-WhatIf] [-Confirm] - [] + [-DefaultProfile ] [-InformationAction ] + [-InformationVariable ] [-WhatIf] [-Confirm] [] ``` ### A lock at the subscription resource scope. ``` Remove-AzureRmResourceLock -LockName [-Force] -ResourceName -ResourceType - [-ApiVersion ] [-Pre] [-InformationAction ] [-InformationVariable ] - [-WhatIf] [-Confirm] [] + [-ApiVersion ] [-Pre] [-DefaultProfile ] + [-InformationAction ] [-InformationVariable ] [-WhatIf] [-Confirm] + [] ``` ### A lock at the tenant resource scope. ``` Remove-AzureRmResourceLock -LockName [-Force] -ResourceName -ResourceType - [-TenantLevel] [-ApiVersion ] [-Pre] [-InformationAction ] - [-InformationVariable ] [-WhatIf] [-Confirm] [] + [-TenantLevel] [-ApiVersion ] [-Pre] [-DefaultProfile ] + [-InformationAction ] [-InformationVariable ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -91,6 +95,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmRoleAssignment.md b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmRoleAssignment.md index 1bc010e7bd95..7c5032c884ff 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmRoleAssignment.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmRoleAssignment.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 8C1D738C-825D-4718-AD2A-9CFEAA7DBD3B online version: schema: 2.0.0 @@ -15,75 +16,77 @@ Removes a role assignment to the specified principal who is assigned to a partic ### EmptyParameterSet (Default) ``` Remove-AzureRmRoleAssignment -ObjectId [-Scope ] -RoleDefinitionName [-PassThru] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ResourceWithObjectIdParameterSet ``` Remove-AzureRmRoleAssignment -ObjectId -ResourceGroupName -ResourceName - -ResourceType [-ParentResource ] -RoleDefinitionName [-PassThru] [-WhatIf] - [-Confirm] [] + -ResourceType [-ParentResource ] -RoleDefinitionName [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ResourceGroupWithObjectIdParameterSet ``` Remove-AzureRmRoleAssignment -ObjectId -ResourceGroupName -RoleDefinitionName - [-PassThru] [-WhatIf] [-Confirm] [] + [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ScopeWithObjectIdParameterSet ``` Remove-AzureRmRoleAssignment -ObjectId [-Scope ] -RoleDefinitionName [-PassThru] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### RoleIdWithScopeAndObjectIdParameterSet ``` -Remove-AzureRmRoleAssignment -ObjectId [-Scope ] -RoleDefinitionId [-PassThru] [-WhatIf] - [-Confirm] [] +Remove-AzureRmRoleAssignment -ObjectId [-Scope ] -RoleDefinitionId [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ResourceWithSignInNameParameterSet ``` Remove-AzureRmRoleAssignment -SignInName -ResourceGroupName -ResourceName - -ResourceType [-ParentResource ] -RoleDefinitionName [-PassThru] [-WhatIf] - [-Confirm] [] + -ResourceType [-ParentResource ] -RoleDefinitionName [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ResourceGroupWithSignInNameParameterSet ``` Remove-AzureRmRoleAssignment -SignInName -ResourceGroupName -RoleDefinitionName - [-PassThru] [-WhatIf] [-Confirm] [] + [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ScopeWithSignInNameParameterSet ``` Remove-AzureRmRoleAssignment -SignInName [-Scope ] -RoleDefinitionName [-PassThru] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ResourceWithSPNParameterSet ``` Remove-AzureRmRoleAssignment -ServicePrincipalName -ResourceGroupName -ResourceName - -ResourceType [-ParentResource ] -RoleDefinitionName [-PassThru] [-WhatIf] - [-Confirm] [] + -ResourceType [-ParentResource ] -RoleDefinitionName [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ResourceGroupWithSPNParameterSet ``` Remove-AzureRmRoleAssignment -ServicePrincipalName -ResourceGroupName - -RoleDefinitionName [-PassThru] [-WhatIf] [-Confirm] [] + -RoleDefinitionName [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### ScopeWithSPNParameterSet ``` Remove-AzureRmRoleAssignment -ServicePrincipalName [-Scope ] -RoleDefinitionName - [-PassThru] [-WhatIf] [-Confirm] [] + [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### RoleAssignmentParameterSet ``` -Remove-AzureRmRoleAssignment [-InputObject] [] +Remove-AzureRmRoleAssignment [-PassThru] [-InputObject] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -132,6 +135,36 @@ Removes the first role assignment object which is fetched from the Get-AzureRmRo ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Role Assignment object. + +```yaml +Type: PSRoleAssignment +Parameter Sets: RoleAssignmentParameterSet +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -ObjectId Azure AD ObjectId of the user, group or service principal. @@ -312,21 +345,6 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -InputObject -Role Assignment object. - -```yaml -Type: PSRoleAssignment -Parameter Sets: RoleAssignmentParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - ### -Confirm Prompts you for confirmation before running the cmdlet. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmRoleDefinition.md b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmRoleDefinition.md index 1401e2ec78fd..5c81be2d3841 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmRoleDefinition.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Remove-AzureRmRoleDefinition.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 2D882B33-2B62-4785-AF8F-5F4644E9504D online version: schema: 2.0.0 @@ -16,14 +17,14 @@ Delete will fail if there are existing role assignments made to the custom role. ### RoleDefinitionIdParameterSet (Default) ``` -Remove-AzureRmRoleDefinition -Id [-Scope ] [-Force] [-PassThru] [-WhatIf] [-Confirm] - [] +Remove-AzureRmRoleDefinition -Id [-Scope ] [-Force] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### RoleDefinitionNameParameterSet ``` -Remove-AzureRmRoleDefinition [-Name] [-Scope ] [-Force] [-PassThru] [-WhatIf] [-Confirm] - [] +Remove-AzureRmRoleDefinition [-Name] [-Scope ] [-Force] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -47,6 +48,21 @@ Remove-AzureRmRoleDefinition -Id "52a6cc13-ff92-47a8-a39b-2a8205c3087e" ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force If set, does not prompt for a confirmation before deleting the custom role diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Save-AzureRmResourceGroupDeploymentTemplate.md b/src/ResourceManager/Resources/Commands.Resources/help/Save-AzureRmResourceGroupDeploymentTemplate.md index 207271e7bf5b..941aee1a891d 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Save-AzureRmResourceGroupDeploymentTemplate.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Save-AzureRmResourceGroupDeploymentTemplate.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 8BB4AD6B-EBE3-442A-83E7-B77A31573208 online version: schema: 2.0.0 @@ -14,8 +15,9 @@ Saves a resource group deployment template to a file. ``` Save-AzureRmResourceGroupDeploymentTemplate -ResourceGroupName -DeploymentName - [-Path ] [-Force] [-ApiVersion ] [-Pre] [-InformationAction ] - [-InformationVariable ] [-WhatIf] [-Confirm] [] + [-Path ] [-Force] [-ApiVersion ] [-Pre] [-DefaultProfile ] + [-InformationAction ] [-InformationVariable ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -48,6 +50,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DeploymentName Specifies the name of the deployment. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmADApplication.md b/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmADApplication.md index 34b05c51398e..2d83e9a06271 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmADApplication.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmADApplication.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: BA97DB6F-F64D-417E-BD72-C2EBB2EC1AA4 online version: schema: 2.0.0 @@ -15,15 +16,15 @@ Updates an existing azure active directory application. ### ApplicationObjectIdWithUpdateParamsParameterSet ``` Set-AzureRmADApplication -ObjectId [-DisplayName ] [-HomePage ] - [-IdentifierUris ] [-ReplyUrls ] [-AvailableToOtherTenants ] [-WhatIf] [-Confirm] - [] + [-IdentifierUris ] [-ReplyUrls ] [-AvailableToOtherTenants ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ApplicationIdWithUpdateParamsParameterSet ``` Set-AzureRmADApplication -ApplicationId [-DisplayName ] [-HomePage ] - [-IdentifierUris ] [-ReplyUrls ] [-AvailableToOtherTenants ] [-WhatIf] [-Confirm] - [] + [-IdentifierUris ] [-ReplyUrls ] [-AvailableToOtherTenants ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -78,6 +79,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DisplayName New Display name for the application. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmADServicePrincipal.md b/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmADServicePrincipal.md index 9cbc0e6f1d1e..d6566387812e 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmADServicePrincipal.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmADServicePrincipal.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 7B8C8239-16A3-4C47-9D6F-DE31885532F4 online version: schema: 2.0.0 @@ -14,14 +15,14 @@ Updates an existing azure active directory service principal. ### SpObjectIdWithDisplayNameParameterSet (Default) ``` -Set-AzureRmADServicePrincipal -ObjectId -DisplayName [-WhatIf] [-Confirm] - [] +Set-AzureRmADServicePrincipal -ObjectId -DisplayName + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### SPNWithDisplayNameParameterSet ``` -Set-AzureRmADServicePrincipal -ServicePrincipalName -DisplayName [-WhatIf] [-Confirm] - [] +Set-AzureRmADServicePrincipal -ServicePrincipalName -DisplayName + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -47,6 +48,21 @@ Updates the display name for the service principal with specified service princi ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DisplayName New display name for the service principal. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmADUser.md b/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmADUser.md index 2c8237a439fc..e9e85ba270ec 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmADUser.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmADUser.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 388D4173-A937-42FA-81CB-C4A27F9D0B04 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Updates an existing active directory user. ``` Set-AzureRmADUser -UPNOrObjectId [-DisplayName ] [-EnableAccount ] - [-Password ] [-ForceChangePasswordNextLogin] [-WhatIf] [-Confirm] [] + [-Password ] [-ForceChangePasswordNextLogin] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -32,6 +34,21 @@ PS C:\> {{ Add example code here }} ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DisplayName New name to display in the address book for the user. Example-'Alex Wu'. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmManagedApplication.md b/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmManagedApplication.md index 6f735df6fbde..92a79b9600ca 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmManagedApplication.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmManagedApplication.md @@ -12,11 +12,20 @@ Updates managed application ## SYNTAX +### The managed application name parameter set. (Default) ``` Set-AzureRmManagedApplication -Name -ResourceGroupName [-ManagedResourceGroupName ] [-ManagedApplicationDefinitionId ] [-Parameter ] [-Kind ] [-Plan ] [-Tag ] [-ApiVersion ] [-Pre] [-DefaultProfile ] [-WhatIf] - [-Confirm] + [-Confirm] [] +``` + +### The managed application Id parameter set. +``` +Set-AzureRmManagedApplication -Id [-ManagedResourceGroupName ] + [-ManagedApplicationDefinitionId ] [-Parameter ] [-Kind ] [-Plan ] + [-Tag ] [-ApiVersion ] [-Pre] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -31,7 +40,6 @@ PS C:\>Set-AzureRmManagedApplication -ResourceId "/subscriptions/mySubId/resourc This command updates the managed application description - ## PARAMETERS ### -ApiVersion @@ -65,6 +73,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Id +The fully qualified managed application Id, including the subscription. e.g. /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName + +```yaml +Type: String +Parameter Sets: The managed application Id parameter set. +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -Kind The managed application kind. One of marketplace or servicecatalog @@ -116,7 +139,7 @@ The managed application name. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: The managed application name parameter set. Aliases: Required: True @@ -177,7 +200,7 @@ The resource group name. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: The managed application name parameter set. Aliases: Required: True @@ -233,17 +256,18 @@ 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 System.Collections.Hashtable - ## OUTPUTS ### System.Management.Automation.PSObject - ## NOTES ## RELATED LINKS diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmManagedApplicationDefinition.md b/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmManagedApplicationDefinition.md index 689dc6d0f538..58418a43d1e3 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmManagedApplicationDefinition.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmManagedApplicationDefinition.md @@ -12,10 +12,19 @@ Updates managed application definition ## SYNTAX +### The managed application definition name parameter set. (Default) ``` Set-AzureRmManagedApplicationDefinition -Name -ResourceGroupName [-DisplayName ] [-Description ] [-PackageFileUri ] [-Authorization ] [-Tag ] [-ApiVersion ] [-Pre] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### The managed application definition Id parameter set. +``` +Set-AzureRmManagedApplicationDefinition -Id [-DisplayName ] [-Description ] + [-PackageFileUri ] [-Authorization ] [-Tag ] [-ApiVersion ] [-Pre] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -109,12 +118,27 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Id +The fully qualified managed application definition Id, including the subscription. e.g. /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName + +```yaml +Type: String +Parameter Sets: The managed application definition Id parameter set. +Aliases: ResourceId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -Name The managed application definition name. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: The managed application definition name parameter set. Aliases: Required: True @@ -159,7 +183,7 @@ The resource group name. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: The managed application definition name parameter set. Aliases: Required: True @@ -215,18 +239,19 @@ 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 System.String[] System.Collections.Hashtable - ## OUTPUTS ### System.Management.Automation.PSObject - ## NOTES ## RELATED LINKS diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmPolicyAssignment.md b/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmPolicyAssignment.md index fe355e9e8427..b2f7df0c876f 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmPolicyAssignment.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmPolicyAssignment.md @@ -16,13 +16,15 @@ Modifies a policy assignment. ### The policy assignment name parameter set. (Default) ``` Set-AzureRmPolicyAssignment -Name -Scope [-NotScope ] [-DisplayName ] - [-ApiVersion ] [-Pre] [-InformationAction ] [-InformationVariable ] - [] + [-Description ] [-Sku ] [-ApiVersion ] [-Pre] + [-DefaultProfile ] [-InformationAction ] + [-InformationVariable ] [] ``` ### The policy assignment Id parameter set. ``` -Set-AzureRmPolicyAssignment -Id [-DisplayName ] [-ApiVersion ] [-Pre] +Set-AzureRmPolicyAssignment -Id [-DisplayName ] [-Description ] [-Sku ] + [-ApiVersion ] [-Pre] [-DefaultProfile ] [-InformationAction ] [-InformationVariable ] [] ``` @@ -65,6 +67,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description for policy assignment + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -DisplayName Specifies a new display name for the policy assignment. @@ -194,6 +226,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Sku +A hash table which represents sku properties + +```yaml +Type: Hashtable +Parameter Sets: (All) +Aliases: SkuObject + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +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). diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmPolicyDefinition.md b/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmPolicyDefinition.md index 6968473650d7..20cb0df426bf 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmPolicyDefinition.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmPolicyDefinition.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: E1AC7139-786C-4DD6-A898-242723E0D159 online version: schema: 2.0.0 @@ -15,15 +16,17 @@ Modifies a policy definition. ### The policy definition name parameter set. (Default) ``` Set-AzureRmPolicyDefinition -Name [-DisplayName ] [-Description ] [-Policy ] - [-ApiVersion ] [-Pre] [-InformationAction ] [-InformationVariable ] - [] + [-Metadata ] [-Parameter ] [-ApiVersion ] [-Pre] + [-DefaultProfile ] [-InformationAction ] + [-InformationVariable ] [] ``` ### The policy definition Id parameter set. ``` Set-AzureRmPolicyDefinition -Id [-DisplayName ] [-Description ] [-Policy ] - [-ApiVersion ] [-Pre] [-InformationAction ] [-InformationVariable ] - [] + [-Metadata ] [-Parameter ] [-ApiVersion ] [-Pre] + [-DefaultProfile ] [-InformationAction ] + [-InformationVariable ] [] ``` ## DESCRIPTION @@ -60,6 +63,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Description Specifies a new description for the policy definition. @@ -144,6 +162,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Metadata +The metadata for policy definition. This can either be a path to a file name containing the metadata, or the metadata as string + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -Name Specifies the name of the policy definition that this cmdlet modifies. @@ -159,6 +192,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Parameter +The parameters declaration for policy definition. This can either be a path to a file name or uri containing the parameters declaration, or the parameters declaration as string + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -Policy Specifies new policy rule for the policy definition. You can specify the path of a .json file or a string that contains the policy in JavaScript Object Notation (JSON) format. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmPolicySetDefinition.md b/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmPolicySetDefinition.md index 46393b1f49f7..9ab71e7b8bb6 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmPolicySetDefinition.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmPolicySetDefinition.md @@ -15,13 +15,15 @@ Modifies a policy set definition ### The policy set definition name parameter set. (Default) ``` Set-AzureRmPolicySetDefinition -Name [-DisplayName ] [-Description ] - [-PolicyDefinition ] [-ApiVersion ] [-Pre] [] + [-PolicyDefinition ] [-ApiVersion ] [-Pre] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ### The policy set definition Id parameter set. ``` Set-AzureRmPolicySetDefinition -Id [-DisplayName ] [-Description ] - [-PolicyDefinition ] [-ApiVersion ] [-Pre] [] + [-PolicyDefinition ] [-ApiVersion ] [-Pre] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -58,6 +60,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Description The description for policy set definition. @@ -150,6 +167,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: 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: 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). diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmResource.md b/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmResource.md index 527ead3abbb3..58f99c8c97bf 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmResource.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmResource.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: A00160B9-831F-4A20-8D9D-9E89BC4F5C91 -online version: +online version: schema: 2.0.0 --- @@ -16,7 +17,8 @@ Modifies a resource. ``` Set-AzureRmResource [-Kind ] [-Properties ] [-Plan ] [-Sku ] [-Tag ] [-UsePatchSemantics] -ResourceId [-ODataQuery ] [-Force] - [-ApiVersion ] [-Pre] [-WhatIf] [-Confirm] [] + [-ApiVersion ] [-Pre] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### Resource that resides at the subscription level. @@ -24,7 +26,8 @@ Set-AzureRmResource [-Kind ] [-Properties ] [-Plan Set-AzureRmResource [-Kind ] [-Properties ] [-Plan ] [-Sku ] [-Tag ] [-UsePatchSemantics] -ResourceName -ResourceType [-ExtensionResourceName ] [-ExtensionResourceType ] [-ODataQuery ] - [-ResourceGroupName ] [-Force] [-ApiVersion ] [-Pre] [-WhatIf] [-Confirm] [] + [-ResourceGroupName ] [-Force] [-ApiVersion ] [-Pre] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### Resource that resides at the tenant level. @@ -32,7 +35,8 @@ Set-AzureRmResource [-Kind ] [-Properties ] [-Plan Set-AzureRmResource [-Kind ] [-Properties ] [-Plan ] [-Sku ] [-Tag ] [-UsePatchSemantics] -ResourceName -ResourceType [-ExtensionResourceName ] [-ExtensionResourceType ] [-ODataQuery ] [-TenantLevel] - [-Force] [-ApiVersion ] [-Pre] [-WhatIf] [-Confirm] [] + [-Force] [-ApiVersion ] [-Pre] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -63,7 +67,22 @@ If you do not specify a version, this cmdlet uses the latest available version. ```yaml Type: String Parameter Sets: (All) -Aliases: +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: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential Required: False Position: Named @@ -81,7 +100,7 @@ server name`/`database name ```yaml Type: String Parameter Sets: Resource that resides at the subscription level., Resource that resides at the tenant level. -Aliases: +Aliases: Required: False Position: Named @@ -99,7 +118,7 @@ For instance, if the extension resource is a database specify the following: ```yaml Type: String Parameter Sets: Resource that resides at the subscription level., Resource that resides at the tenant level. -Aliases: +Aliases: Required: False Position: Named @@ -114,7 +133,7 @@ Forces the command to run without asking for user confirmation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -129,7 +148,7 @@ Specifies the resource kind for the resource. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -145,7 +164,7 @@ This cmdlet appends this value to the request in addition to any other filters. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -175,7 +194,7 @@ Indicates that this cmdlet considers pre-release API versions when it automatica ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -205,7 +224,7 @@ Specifies the name of the resource group where this cmdlet modifies the resource ```yaml Type: String Parameter Sets: Resource that resides at the subscription level. -Aliases: +Aliases: Required: False Position: Named @@ -258,7 +277,7 @@ For instance, for a database, the resource type is as follows: ```yaml Type: String Parameter Sets: Resource that resides at the subscription level., Resource that resides at the tenant level. -Aliases: +Aliases: Required: True Position: Named @@ -305,7 +324,7 @@ Indicates that this cmdlet operates at the tenant level. ```yaml Type: SwitchParameter Parameter Sets: Resource that resides at the tenant level. -Aliases: +Aliases: Required: True Position: Named @@ -320,7 +339,7 @@ Indicates that this cmdlet uses an HTTP PATCH to update the object, instead of a ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmResourceGroup.md b/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmResourceGroup.md index c1674f061379..fa51e7ffc330 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmResourceGroup.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmResourceGroup.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 4E5C059B-36F3-41C8-9FDB-69F5318CF39B -online version: +online version: schema: 2.0.0 --- @@ -14,12 +15,14 @@ Modifies a resource group. ### Lists the resource group based in the name. (Default) ``` -Set-AzureRmResourceGroup [-Name] [-Tag] [-ApiVersion ] [-Pre] [] +Set-AzureRmResourceGroup [-Name] [-Tag] [-ApiVersion ] [-Pre] + [-DefaultProfile ] [] ``` ### Lists the resource group based in the Id. ``` -Set-AzureRmResourceGroup [-Tag] [-Id] [-ApiVersion ] [-Pre] [] +Set-AzureRmResourceGroup [-Tag] [-Id] [-ApiVersion ] [-Pre] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -82,7 +85,22 @@ You can specify a different version than the default version. ```yaml Type: String Parameter Sets: (All) -Aliases: +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: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential Required: False Position: Named @@ -127,7 +145,7 @@ Indicates that this cmdlet considers pre-release API versions when it automatica ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmResourceLock.md b/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmResourceLock.md index 02c31da822e9..63051e851f70 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmResourceLock.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmResourceLock.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 770093CD-CE2A-4076-8A28-F4DCFFB7A075 online version: schema: 2.0.0 @@ -15,53 +16,57 @@ Modifies a resource lock. ### A lock at the specified scope. (Default) ``` Set-AzureRmResourceLock -LockName -LockLevel [-LockNotes ] [-Force] - -Scope [-ApiVersion ] [-Pre] [-InformationAction ] - [-InformationVariable ] [-WhatIf] [-Confirm] [] + -Scope [-ApiVersion ] [-Pre] [-DefaultProfile ] + [-InformationAction ] [-InformationVariable ] [-WhatIf] [-Confirm] + [] ``` ### A lock at the resource group scope. ``` Set-AzureRmResourceLock -LockName -LockLevel [-LockNotes ] [-Force] - -ResourceGroupName [-ApiVersion ] [-Pre] [-InformationAction ] - [-InformationVariable ] [-WhatIf] [-Confirm] [] + -ResourceGroupName [-ApiVersion ] [-Pre] [-DefaultProfile ] + [-InformationAction ] [-InformationVariable ] [-WhatIf] [-Confirm] + [] ``` ### A lock at the resource group resource scope. ``` Set-AzureRmResourceLock -LockName -LockLevel [-LockNotes ] [-Force] -ResourceName -ResourceType -ResourceGroupName [-ApiVersion ] [-Pre] - [-InformationAction ] [-InformationVariable ] [-WhatIf] [-Confirm] - [] + [-DefaultProfile ] [-InformationAction ] + [-InformationVariable ] [-WhatIf] [-Confirm] [] ``` ### A lock at the subscription scope. ``` Set-AzureRmResourceLock -LockName -LockLevel [-LockNotes ] [-Force] - [-ApiVersion ] [-Pre] [-InformationAction ] [-InformationVariable ] - [-WhatIf] [-Confirm] [] + [-ApiVersion ] [-Pre] [-DefaultProfile ] + [-InformationAction ] [-InformationVariable ] [-WhatIf] [-Confirm] + [] ``` ### A lock at the subscription resource scope. ``` Set-AzureRmResourceLock -LockName -LockLevel [-LockNotes ] [-Force] -ResourceName -ResourceType [-ApiVersion ] [-Pre] - [-InformationAction ] [-InformationVariable ] [-WhatIf] [-Confirm] - [] + [-DefaultProfile ] [-InformationAction ] + [-InformationVariable ] [-WhatIf] [-Confirm] [] ``` ### A lock at the tenant resource scope. ``` Set-AzureRmResourceLock -LockName -LockLevel [-LockNotes ] [-Force] -ResourceName -ResourceType [-TenantLevel] [-ApiVersion ] [-Pre] - [-InformationAction ] [-InformationVariable ] [-WhatIf] [-Confirm] - [] + [-DefaultProfile ] [-InformationAction ] + [-InformationVariable ] [-WhatIf] [-Confirm] [] ``` ### A lock, by Id. ``` Set-AzureRmResourceLock -LockLevel [-LockNotes ] [-Force] -LockId - [-ApiVersion ] [-Pre] [-InformationAction ] [-InformationVariable ] - [-WhatIf] [-Confirm] [] + [-ApiVersion ] [-Pre] [-DefaultProfile ] + [-InformationAction ] [-InformationVariable ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -94,6 +99,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmRoleDefinition.md b/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmRoleDefinition.md index 028e5f2550a5..2c2f6476f1fb 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmRoleDefinition.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Set-AzureRmRoleDefinition.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Resources.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 115A7612-4856-47AE-AEE4-918350CD7009 online version: schema: 2.0.0 @@ -18,12 +19,13 @@ Finally, save the role definition using this command. ### InputFileParameterSet ``` -Set-AzureRmRoleDefinition -InputFile [] +Set-AzureRmRoleDefinition -InputFile [-DefaultProfile ] [] ``` ### RoleDefinitionParameterSet ``` -Set-AzureRmRoleDefinition -Role [] +Set-AzureRmRoleDefinition -Role [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -66,6 +68,21 @@ PS C:\> Set-AzureRmRoleDefinition -InputFile C:\Temp\roleDefinition.json ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InputFile File name containing a single json role definition to be updated. Only include the properties that are to be updated in the JSON. @@ -104,7 +121,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### PSRoleDefinition - Parameter 'Role' accepts value of type 'PSRoleDefinition' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Stop-AzureRmResourceGroupDeployment.md b/src/ResourceManager/Resources/Commands.Resources/help/Stop-AzureRmResourceGroupDeployment.md index ca77982b577f..6b651ca45012 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Stop-AzureRmResourceGroupDeployment.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Stop-AzureRmResourceGroupDeployment.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 089954C3-7F3E-46C2-AA93-C0151EACDA2F online version: schema: 2.0.0 @@ -15,13 +16,13 @@ Cancels a resource group deployment. ### The deployment name parameter set. (Default) ``` Stop-AzureRmResourceGroupDeployment [-ResourceGroupName] [-Name] [-ApiVersion ] - [-Pre] [-WhatIf] [-Confirm] [] + [-Pre] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### The deployment Id parameter set. ``` -Stop-AzureRmResourceGroupDeployment -Id [-ApiVersion ] [-Pre] [-WhatIf] [-Confirm] - [] +Stop-AzureRmResourceGroupDeployment -Id [-ApiVersion ] [-Pre] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -64,6 +65,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id Specifies the ID of the resource group deployment to stop. diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Test-AzureRmResourceGroupDeployment.md b/src/ResourceManager/Resources/Commands.Resources/help/Test-AzureRmResourceGroupDeployment.md index e8f1c253bb10..09c7a294a34b 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Test-AzureRmResourceGroupDeployment.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Test-AzureRmResourceGroupDeployment.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: 0143CE35-3B1D-4829-B880-A5CA25B83883 online version: schema: 2.0.0 @@ -15,49 +16,55 @@ Validates a resource group deployment. ### Deployment via template file without parameters (Default) ``` Test-AzureRmResourceGroupDeployment -ResourceGroupName [-Mode ] -TemplateFile - [-ApiVersion ] [-Pre] [] + [-ApiVersion ] [-Pre] [-DefaultProfile ] [] ``` ### Deployment via template file and template parameters object ``` Test-AzureRmResourceGroupDeployment -ResourceGroupName [-Mode ] - -TemplateParameterObject -TemplateFile [-ApiVersion ] [-Pre] [] + -TemplateParameterObject -TemplateFile [-ApiVersion ] [-Pre] + [-DefaultProfile ] [] ``` ### Deployment via template uri and template parameters object ``` Test-AzureRmResourceGroupDeployment -ResourceGroupName [-Mode ] - -TemplateParameterObject -TemplateUri [-ApiVersion ] [-Pre] [] + -TemplateParameterObject -TemplateUri [-ApiVersion ] [-Pre] + [-DefaultProfile ] [] ``` ### Deployment via template file and template parameters file ``` Test-AzureRmResourceGroupDeployment -ResourceGroupName [-Mode ] - -TemplateParameterFile -TemplateFile [-ApiVersion ] [-Pre] [] + -TemplateParameterFile -TemplateFile [-ApiVersion ] [-Pre] + [-DefaultProfile ] [] ``` ### Deployment via template uri and template parameters file ``` Test-AzureRmResourceGroupDeployment -ResourceGroupName [-Mode ] - -TemplateParameterFile -TemplateUri [-ApiVersion ] [-Pre] [] + -TemplateParameterFile -TemplateUri [-ApiVersion ] [-Pre] + [-DefaultProfile ] [] ``` ### Deployment via template file template parameters uri ``` Test-AzureRmResourceGroupDeployment -ResourceGroupName [-Mode ] - -TemplateParameterUri -TemplateFile [-ApiVersion ] [-Pre] [] + -TemplateParameterUri -TemplateFile [-ApiVersion ] [-Pre] + [-DefaultProfile ] [] ``` ### Deployment via template uri and template parameters uri ``` Test-AzureRmResourceGroupDeployment -ResourceGroupName [-Mode ] - -TemplateParameterUri -TemplateUri [-ApiVersion ] [-Pre] [] + -TemplateParameterUri -TemplateUri [-ApiVersion ] [-Pre] + [-DefaultProfile ] [] ``` ### Deployment via template uri without parameters ``` Test-AzureRmResourceGroupDeployment -ResourceGroupName [-Mode ] -TemplateUri - [-ApiVersion ] [-Pre] [] + [-ApiVersion ] [-Pre] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -88,6 +95,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Mode Specifies the deployment mode. The acceptable values for this parameter are: diff --git a/src/ResourceManager/Resources/Commands.Resources/help/Unregister-AzureRmResourceProvider.md b/src/ResourceManager/Resources/Commands.Resources/help/Unregister-AzureRmResourceProvider.md index b70eb1323637..86c7352fde61 100644 --- a/src/ResourceManager/Resources/Commands.Resources/help/Unregister-AzureRmResourceProvider.md +++ b/src/ResourceManager/Resources/Commands.Resources/help/Unregister-AzureRmResourceProvider.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.ResourceManager.Cmdlets.dll-Help.xml +Module Name: AzureRM.Resources ms.assetid: D5126B7B-7FBB-4C72-B77E-13ADE2BE9B1B online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Unregisters a resource provider. ## SYNTAX ``` -Unregister-AzureRmResourceProvider -ProviderNamespace [-ApiVersion ] [-Pre] [-WhatIf] - [-Confirm] [] +Unregister-AzureRmResourceProvider -ProviderNamespace [-ApiVersion ] [-Pre] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,6 +46,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Pre Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Add-AzureRmSqlDatabaseToFailoverGroup.md b/src/ResourceManager/Sql/Commands.Sql/help/Add-AzureRmSqlDatabaseToFailoverGroup.md index 7e3577920359..4c7c53f1ae11 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Add-AzureRmSqlDatabaseToFailoverGroup.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Add-AzureRmSqlDatabaseToFailoverGroup.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -14,7 +15,7 @@ Adds one or more databases to an Azure SQL Database Failover Group. ``` Add-AzureRmSqlDatabaseToFailoverGroup [-ServerName] [-FailoverGroupName] -Database - [-ResourceGroupName] [] + [-ResourceGroupName] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -67,6 +68,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -FailoverGroupName The name of the Azure SQL Database Failover Group. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Add-AzureRmSqlServerKeyVaultKey.md b/src/ResourceManager/Sql/Commands.Sql/help/Add-AzureRmSqlServerKeyVaultKey.md index 88a0e9f3506f..301ba49b682f 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Add-AzureRmSqlServerKeyVaultKey.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Add-AzureRmSqlServerKeyVaultKey.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -13,7 +14,7 @@ Adds a Key Vault key to a SQL server. ``` Add-AzureRmSqlServerKeyVaultKey [-KeyId] [-ServerName] [-ResourceGroupName] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -39,6 +40,21 @@ CreationDate : 1/1/2017 12:00:00 AM ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -KeyId The Azure Key Vault KeyId. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/AzureRM.Sql.md b/src/ResourceManager/Sql/Commands.Sql/help/AzureRM.Sql.md index 359813e0e6f6..8581a291f6db 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/AzureRM.Sql.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/AzureRM.Sql.md @@ -29,6 +29,9 @@ Gets the status of database operations. ### [Get-AzureRmSqlDatabaseAdvisor](Get-AzureRmSqlDatabaseAdvisor.md) Gets one or more Advisors for an Azure SQL Database. +### [Get-AzureRmSqlDatabaseAuditing](Get-AzureRmSqlDatabaseAuditing.md) +Gets the auditing settings of an Azure SQL database. + ### [Get-AzureRmSqlDatabaseAuditingPolicy](Get-AzureRmSqlDatabaseAuditingPolicy.md) Gets the auditing policy of a database. @@ -113,6 +116,9 @@ Gets information about an Azure AD administrator for SQL Server. ### [Get-AzureRmSqlServerAdvisor](Get-AzureRmSqlServerAdvisor.md) Gets one or more Advisors for an Azure SQL Server. +### [Get-AzureRmSqlServerAuditing](Get-AzureRmSqlServerAuditing.md) +Gets the auditing settings of an Azure SQL server. + ### [Get-AzureRmSqlServerAuditingPolicy](Get-AzureRmSqlServerAuditingPolicy.md) Gets the auditing policy of a SQL server. @@ -152,6 +158,27 @@ Gets the status of an Azure SQL Database server upgrade. ### [Get-AzureRmSqlServerUpgradeHint](Get-AzureRmSqlServerUpgradeHint.md) Gets pricing tier hints for upgrading an Azure SQL Database server. +### [Get-AzureRmSqlServerVirtualNetworkRule](Get-AzureRmSqlServerVirtualNetworkRule.md) +Gets or lists Azure SQL Server Virtual Network Rule. + +### [Get-AzureRmSqlSyncAgent](Get-AzureRmSqlSyncAgent.md) +Returns information about Azure SQL Sync Agents. + +### [Get-AzureRmSqlSyncAgentLinkedDatabase](Get-AzureRmSqlSyncAgentLinkedDatabase.md) +Returns information about SQL Server databases linked by a sync agent. + +### [Get-AzureRmSqlSyncGroup](Get-AzureRmSqlSyncGroup.md) +Returns information about Azure SQL Database Sync Groups. + +### [Get-AzureRmSqlSyncGroupLog](Get-AzureRmSqlSyncGroupLog.md) +Returns the logs of an Azure SQL Database Sync Group. + +### [Get-AzureRmSqlSyncMember](Get-AzureRmSqlSyncMember.md) +Returns information about Azure SQL Database Sync Members. + +### [Get-AzureRmSqlSyncSchema](Get-AzureRmSqlSyncSchema.md) +Returns information about the sync schema of a member database or a hub database. + ### [New-AzureRmSqlDatabase](New-AzureRmSqlDatabase.md) Creates a database or an elastic database. @@ -188,6 +215,21 @@ Creates a database server system recovery configuration. ### [New-AzureRmSqlServerFirewallRule](New-AzureRmSqlServerFirewallRule.md) Creates a firewall rule for a SQL Database server. +### [New-AzureRmSqlServerVirtualNetworkRule](New-AzureRmSqlServerVirtualNetworkRule.md) +Creates an Azure SQL Server Virtual Network Rule. + +### [New-AzureRmSqlSyncAgent](New-AzureRmSqlSyncAgent.md) +Creates an Azure SQL Sync Agent. + +### [New-AzureRmSqlSyncAgentKey](New-AzureRmSqlSyncAgentKey.md) +Creates an Azure SQL Sync Agent Key. + +### [New-AzureRmSqlSyncGroup](New-AzureRmSqlSyncGroup.md) +Creates an Azure SQL Database Sync Group. + +### [New-AzureRmSqlSyncMember](New-AzureRmSqlSyncMember.md) +Creates an Azure SQL Database Sync Member. + ### [Remove-AzureRmSqlDatabase](Remove-AzureRmSqlDatabase.md) Removes an Azure SQL database. @@ -236,6 +278,18 @@ Removes a Key Vault key from a SQL server. ### [Remove-AzureRmSqlServerThreatDetectionPolicy](Remove-AzureRmSqlServerThreatDetectionPolicy.md) Removes the threat detection policy from a server. +### [Remove-AzureRmSqlServerVirtualNetworkRule](Remove-AzureRmSqlServerVirtualNetworkRule.md) +Deletes an Azure SQL Server Virtual Network Rule. + +### [Remove-AzureRmSqlSyncAgent](Remove-AzureRmSqlSyncAgent.md) +Removes an Azure SQL Sync Agent. + +### [Remove-AzureRmSqlSyncGroup](Remove-AzureRmSqlSyncGroup.md) +Removes an Azure SQL Database Sync Group. + +### [Remove-AzureRmSqlSyncMember](Remove-AzureRmSqlSyncMember.md) +Removes an Azure SQL Database Sync Member. + ### [Restore-AzureRmSqlDatabase](Restore-AzureRmSqlDatabase.md) Restores a SQL database. @@ -248,6 +302,9 @@ Sets properties for a database, or moves an existing database into an elastic po ### [Set-AzureRmSqlDatabaseAdvisorAutoExecuteStatus](Set-AzureRmSqlDatabaseAdvisorAutoExecuteStatus.md) Modifies auto execute status of an Azure SQL Database Advisor. +### [Set-AzureRmSqlDatabaseAuditing](Set-AzureRmSqlDatabaseAuditing.md) +Changes the auditing settings for an Azure SQL database. + ### [Set-AzureRmSqlDatabaseAuditingPolicy](Set-AzureRmSqlDatabaseAuditingPolicy.md) Sets the auditing policy for a database. @@ -279,7 +336,7 @@ Sets a threat detection policy on a database. Modifies TDE property for a database. ### [Set-AzureRmSqlElasticPool](Set-AzureRmSqlElasticPool.md) -Modifies properties of an elastic database pool in a SQL Database. +Modifies properties of an elastic database pool in Azure SQL Database. ### [Set-AzureRmSqlElasticPoolAdvisorAutoExecuteStatus](Set-AzureRmSqlElasticPoolAdvisorAutoExecuteStatus.md) Updates auto execute status of an Azure SQL Elastic Pool Advisor. @@ -296,6 +353,9 @@ Provisions an Azure AD administrator for SQL Server. ### [Set-AzureRmSqlServerAdvisorAutoExecuteStatus](Set-AzureRmSqlServerAdvisorAutoExecuteStatus.md) Updates the auto execute status of an Azure SQL Server Advisor. +### [Set-AzureRmSqlServerAuditing](Set-AzureRmSqlServerAuditing.md) +Changes the auditing settings of an Azure SQL server. + ### [Set-AzureRmSqlServerAuditingPolicy](Set-AzureRmSqlServerAuditingPolicy.md) Changes the auditing policy of a SQL Database server. @@ -317,12 +377,18 @@ Sets a threat detection policy on a server. ### [Set-AzureRmSqlServerTransparentDataEncryptionProtector](Set-AzureRmSqlServerTransparentDataEncryptionProtector.md) Sets the Transparent Data Encryption (TDE) protector for a SQL server. +### [Set-AzureRmSqlServerVirtualNetworkRule](Set-AzureRmSqlServerVirtualNetworkRule.md) +Modifies the configuration of an Azure SQL Server Virtual Network Rule. + ### [Start-AzureRmSqlDatabaseExecuteIndexRecommendation](Start-AzureRmSqlDatabaseExecuteIndexRecommendation.md) Starts the workflow that runs a recommended index operation. ### [Start-AzureRmSqlServerUpgrade](Start-AzureRmSqlServerUpgrade.md) Starts the upgrade of a SQL Database server. +### [Start-AzureRmSqlSyncGroupSync](Start-AzureRmSqlSyncGroupSync.md) +Starts a sync group synchronization. + ### [Stop-AzureRmSqlDatabaseActivity](Stop-AzureRmSqlDatabaseActivity.md) Cancels the asynchronous operation on the database. @@ -332,62 +398,25 @@ Stops the workflow that runs a recommended index operation. ### [Stop-AzureRmSqlServerUpgrade](Stop-AzureRmSqlServerUpgrade.md) Stops the upgrade of a SQL Database server. +### [Stop-AzureRmSqlSyncGroupSync](Stop-AzureRmSqlSyncGroupSync.md) +Stops a sync group synchronization. + ### [Suspend-AzureRmSqlDatabase](Suspend-AzureRmSqlDatabase.md) Suspends a SQL Data Warehouse database. ### [Switch-AzureRmSqlDatabaseFailoverGroup](Switch-AzureRmSqlDatabaseFailoverGroup.md) Executes a failover of an Azure SQL Database Failover Group. -### [Use-AzureRmSqlServerAuditingPolicy](Use-AzureRmSqlServerAuditingPolicy.md) -Specifies that a database uses the auditing policy of its host server. - -### [New-AzureRmSqlSyncGroup](New-AzureRmSqlSyncGroup.md) -Creates an Azure SQL Database Sync Group. - ### [Update-AzureRmSqlSyncGroup](Update-AzureRmSqlSyncGroup.md) Updates an Azure SQL Database Sync Group. -### [Get-AzureRmSqlSyncGroup](Get-AzureRmSqlSyncGroup.md) -Returns information about Azure SQL Database Sync Groups. - -### [Remove-AzureRmSqlSyncGroup](Remove-AzureRmSqlSyncGroup.md) -Removes an Azure SQL Database Sync Group. - -### [Start-AzureRmSqlSyncGroupSync](Start-AzureRmSqlSyncGroupSync.md) -Starts a sync group synchronization. - -### [Stop-AzureRmSqlSyncGroupSync](Stop-AzureRmSqlSyncGroupSync.md) -Stops a sync group synchronization. - -### [Get-AzureRmSqlSyncGroupLog](Get-AzureRmSqlSyncGroupLog.md) -Returns the logs of an Azure SQL Database Sync Group. - -### [New-AzureRmSqlSyncMember](New-AzureRmSqlSyncMember.md) -Creates an Azure SQL Database Sync Member. - ### [Update-AzureRmSqlSyncMember](Update-AzureRmSqlSyncMember.md) Updates an Azure SQL Database Sync Member. -### [Get-AzureRmSqlSyncMember](Get-AzureRmSqlSyncMember.md) -Returns information about Azure SQL Database Sync Members. - -### [Remove-AzureRmSqlSyncMember](Remove-AzureRmSqlSyncMember.md) -Removes an Azure SQL Database Sync Member. - -### [New-AzureRmSqlSyncAgent](New-AzureRmSqlSyncAgent.md) -Creates an Azure SQL Sync Agent. - -### [New-AzureRmSqlSyncAgentKey](New-AzureRmSqlSyncAgentKey.md) -Creates an Azure SQL Sync Agent Key. - -### [Get-AzureRmSqlSyncAgent](Get-AzureRmSqlSyncAgent.md) -Returns information about Azure SQL Sync Agents. - -### [Remove-AzureRmSqlSyncAgent](Remove-AzureRmSqlSyncAgent.md) -Removes an Azure SQL Sync Agent. - -### [Get-AzureRmSqlSyncAgentLinkedDatabase](Get-AzureRmSqlSyncAgentLinkedDatabase.md) -Returns information about SQL Server databases linked by a sync agent. +### [Update-AzureRmSqlSyncSchema](Update-AzureRmSqlSyncSchema.md) +Update the sync schema for a sync member database or a sync hub database. +It will get the the latest database schema from the real database and then use it refresh the schema cached by Sync metadata database. +If "SyncMemberName" is specified, it will refresh the member database schema; if not, it will refresh the hub database schema. -### [Stop-AzureRmSqlDatabaseActivity](Stop-AzureRmSqlDatabaseActivity.md) -Cancels the asynchronous operation on the database. +### [Use-AzureRmSqlServerAuditingPolicy](Use-AzureRmSqlServerAuditingPolicy.md) +Specifies that a database uses the auditing policy of its host server. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRMSqlDatabaseGeoBackup.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRMSqlDatabaseGeoBackup.md index 7c176f0f04a1..df4d62961ff3 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRMSqlDatabaseGeoBackup.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRMSqlDatabaseGeoBackup.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 256AA6F4-D856-4713-A0AC-0DA1A145AA5C online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets a geo-redundant backup of a database. ``` Get-AzureRmSqlDatabaseGeoBackup [-ServerName] [[-DatabaseName] ] [-ResourceGroupName] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -58,6 +59,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group to which the SQL database server is assigned. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRMSqlDeletedDatabaseBackup.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRMSqlDeletedDatabaseBackup.md index 0071433173d9..5fcdaf524352 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRMSqlDeletedDatabaseBackup.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRMSqlDeletedDatabaseBackup.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 62B9754D-5EBF-4BEE-B07A-3E508C918F03 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Gets a deleted database that you can restore. ``` Get-AzureRmSqlDeletedDatabaseBackup [-ServerName] [[-DatabaseName] ] - [[-DeletionDate] ] [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [[-DeletionDate] ] [-ResourceGroupName] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -55,6 +57,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DeletionDate Specifies the date, as a **DateTime** object, that the database was deleted. To get a **DateTime** object, use the Get-Date cmdlet. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlCapability.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlCapability.md index 0c7640b9641e..c0c3f095ac87 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlCapability.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlCapability.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 8C5D29AD-0B15-4CD4-8637-86ABD19F41C8 online version: schema: 2.0.0 @@ -15,12 +16,14 @@ Gets SQL Database capabilities for the current subscription. ### FilterResults (Default) ``` Get-AzureRmSqlCapability [-LocationName] [-ServerVersionName ] [-EditionName ] - [-ServiceObjectiveName ] [-WhatIf] [-Confirm] [] + [-ServiceObjectiveName ] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### DefaultResults ``` -Get-AzureRmSqlCapability [-LocationName] [-Defaults] [-WhatIf] [-Confirm] [] +Get-AzureRmSqlCapability [-LocationName] [-Defaults] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -62,6 +65,21 @@ This command gets default capabilities for SQL Databases for the specified servi ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Defaults Indicates that this cmdlet gets only defaults. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabase.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabase.md index 0a95d74bf95a..4b049d9756ad 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabase.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabase.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 0C8AC52C-4E70-493C-A299-79CE32EC5EF1 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets one or more databases. ``` Get-AzureRmSqlDatabase [[-DatabaseName] ] [-ServerName] [-ResourceGroupName] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -110,6 +111,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group to which the database server is assigned. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseAdvisor.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseAdvisor.md index 00a7d7eca39d..90e1cb5c165d 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseAdvisor.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseAdvisor.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 5AAB22C6-8E3C-4BDC-8A54-DA5A9906B762 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Gets one or more Advisors for an Azure SQL Database. ``` Get-AzureRmSqlDatabaseAdvisor [-AdvisorName ] [-ExpandRecommendedActions] -ServerName - -DatabaseName [-ResourceGroupName] [] + -DatabaseName [-ResourceGroupName] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -199,6 +201,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExpandRecommendedActions Indicates that this cmdlet gets the recommended actions with the response. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseAuditing.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseAuditing.md index b7d6e7f4ebe0..f5c66da80e62 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseAuditing.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseAuditing.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 14814BF3-51AF-4E51-A8A6-661825BD88D1 online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Gets the auditing settings of an Azure SQL database. ## SYNTAX ``` -Get-AzureRmSqlDatabaseAuditing [-ServerName] [-DatabaseName] - [-ResourceGroupName] [-WhatIf] [-Confirm] [] +Get-AzureRmSqlDatabaseAuditing [-ServerName] [-DatabaseName] [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -55,6 +56,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +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. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseAuditingPolicy.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseAuditingPolicy.md index 97fa7f0ecbf7..e411978fb898 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseAuditingPolicy.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseAuditingPolicy.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 14814BF3-51AF-4E51-A8A6-661825BD88D1 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Gets the auditing policy of a database. ``` Get-AzureRmSqlDatabaseAuditingPolicy [-ServerName] [-DatabaseName] - [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -73,6 +75,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group to which the database is assigned. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseBackupLongTermRetentionPolicy.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseBackupLongTermRetentionPolicy.md index bc160f61c02b..9377beb392b2 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseBackupLongTermRetentionPolicy.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseBackupLongTermRetentionPolicy.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 1C0AF5B2-7187-4BFA-8DBB-A771FD2E00A4 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Gets a database long term retention policy. ``` Get-AzureRmSqlDatabaseBackupLongTermRetentionPolicy [-ServerName] [-DatabaseName] - [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -45,6 +47,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group that contains the database. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseDataMaskingPolicy.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseDataMaskingPolicy.md index 507ed079fa11..28c30fb035b1 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseDataMaskingPolicy.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseDataMaskingPolicy.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: FFC02A5D-A12F-494D-8542-76A5B89E32DC online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Gets the data masking policy for a database. ``` Get-AzureRmSqlDatabaseDataMaskingPolicy [-ServerName] [-DatabaseName] - [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -54,6 +56,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group to which the database is assigned. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseDataMaskingRule.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseDataMaskingRule.md index 5c5318ca07c0..60a93449a1f7 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseDataMaskingRule.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseDataMaskingRule.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 848A6972-AB29-46FB-8E03-FF2ADB113A0E online version: schema: 2.0.0 @@ -14,8 +15,8 @@ Gets the data masking rules from a database. ``` Get-AzureRmSqlDatabaseDataMaskingRule [-SchemaName ] [-TableName ] [-ColumnName ] - [-ServerName] [-DatabaseName] [-ResourceGroupName] [-WhatIf] [-Confirm] - [] + [-ServerName] [-DatabaseName] [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -106,6 +107,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group to which the database is assigned. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseExpanded.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseExpanded.md index 778b98fbc70b..1276af6ca343 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseExpanded.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseExpanded.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 952967EB-AEAD-4597-B837-6669CE73739E online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets a database and its expanded property values. ``` Get-AzureRmSqlDatabaseExpanded [-ServerName] [[-DatabaseName] ] [-ResourceGroupName] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -48,6 +49,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group to which the server is assigned. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseFailoverGroup.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseFailoverGroup.md index aaae6ddff5e8..2ec818bcecda 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseFailoverGroup.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseFailoverGroup.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -13,7 +14,7 @@ Gets or lists Azure SQL Database Failover Groups. ``` Get-AzureRmSqlDatabaseFailoverGroup [-ServerName] [[-FailoverGroupName] ] - [-ResourceGroupName] [] + [-ResourceGroupName] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -39,6 +40,21 @@ Get a specific Failover Group. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -FailoverGroupName The name of the Azure SQL Database Failover Group to retrieve. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseGeoBackupPolicy.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseGeoBackupPolicy.md index 8a0242fd0bc4..5ccb8190e4fd 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseGeoBackupPolicy.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseGeoBackupPolicy.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 4F28BA63-23FC-4E35-A7FB-726E6FE94D26 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets a database geo backup policy. ``` Get-AzureRmSqlDatabaseGeoBackupPolicy [-ServerName] [-DatabaseName] - [-ResourceGroupName] [] + [-ResourceGroupName] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -45,6 +46,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group of the server that contains this database. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseImportExportStatus.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseImportExportStatus.md index 1bb532d01230..0ea9be3b32bd 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseImportExportStatus.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseImportExportStatus.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 5D4F13F9-57E7-446B-AA28-8C44B149E1CB online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Gets the details of an import or export of an Azure SQL Database. ## SYNTAX ``` -Get-AzureRmSqlDatabaseImportExportStatus [-OperationStatusLink] [-WhatIf] [-Confirm] - [] +Get-AzureRmSqlDatabaseImportExportStatus [-OperationStatusLink] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -39,6 +40,21 @@ This command gets the status of an import or export request for a database at th ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OperationStatusLink Specifies the status link that is returned from the New-AzureRmSqlDatabaseExport or New-AzureRmSqlDatabaseImport cmdlets. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseIndexRecommendations.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseIndexRecommendations.md index e6daa8502901..7c041121e792 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseIndexRecommendations.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseIndexRecommendations.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 10656EA5-EA5F-4394-951F-BC64BE3BF6F9 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Gets the recommended index operations for a server or database. ``` Get-AzureRmSqlDatabaseIndexRecommendations -ServerName [-DatabaseName ] [-TableName ] - [-IndexRecommendationName ] [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-IndexRecommendationName ] [-ResourceGroupName] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -60,6 +62,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IndexRecommendationName Specifies the name of the index recommendation that this cmdlet gets. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseRecommendedAction.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseRecommendedAction.md index b343a6cf7cee..714afe18a91e 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseRecommendedAction.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseRecommendedAction.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: EF6C862B-A89C-48AB-A590-92CFA387305F online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Gets one or more recommended actions for an Azure SQL Database Advisor. ``` Get-AzureRmSqlDatabaseRecommendedAction [-RecommendedActionName ] -ServerName - -DatabaseName -AdvisorName [-ResourceGroupName] [] + -DatabaseName -AdvisorName [-ResourceGroupName] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -185,6 +187,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RecommendedActionName Specifies the name of the recommended action that this cmdlet gets. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseReplicationLink.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseReplicationLink.md index e695b1e5a195..6e14cfc4eb56 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseReplicationLink.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseReplicationLink.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 40054224-52FF-4AF6-A090-9F6D07A2BA99 online version: schema: 2.0.0 @@ -15,14 +16,15 @@ Gets the geo-replication links between an Azure SQL Database and a resource grou ### ByDatabaseName (Default) ``` Get-AzureRmSqlDatabaseReplicationLink [-DatabaseName] -PartnerResourceGroupName - [-ServerName] [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ServerName] [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ### ByPartnerServerName ``` Get-AzureRmSqlDatabaseReplicationLink [-DatabaseName] -PartnerResourceGroupName - [-PartnerServerName ] [-ServerName] [-ResourceGroupName] [-WhatIf] [-Confirm] - [] + [-PartnerServerName ] [-ServerName] [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -53,6 +55,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PartnerResourceGroupName Specifies the name of the resource group to which the partner is assigned. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseRestorePoints.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseRestorePoints.md index b342d599347f..6cf67acc8791 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseRestorePoints.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseRestorePoints.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 67A9BB67-CF17-4CAA-99D9-002D0D23178B online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Retrieves the distinct restore points from which a SQL Data Warehouse can be res ``` Get-AzureRmSqlDatabaseRestorePoints [-ServerName] [-DatabaseName] - [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -57,6 +59,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group to which the SQL Database is assigned. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseSecureConnectionPolicy.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseSecureConnectionPolicy.md index c368cec0f431..9b48528fffd9 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseSecureConnectionPolicy.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseSecureConnectionPolicy.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: F22E14D6-B18B-4136-B1DF-710DA34372C3 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Gets the secure connection policy for a database. ``` Get-AzureRmSqlDatabaseSecureConnectionPolicy [-ServerName] [-DatabaseName] - [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -58,6 +60,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group to which the database is assigned. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseThreatDetectionPolicy.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseThreatDetectionPolicy.md index c3d2c1309fcd..9965110c7e7b 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseThreatDetectionPolicy.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseThreatDetectionPolicy.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 017EF522-ABC5-40EE-B8DC-369D097F49D0 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Gets the threat detection policy for a database. ``` Get-AzureRmSqlDatabaseThreatDetectionPolicy [-ServerName] [-DatabaseName] - [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -57,6 +59,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group to which the server is assigned. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseTransparentDataEncryption.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseTransparentDataEncryption.md index 4b1b0a8135e7..6de73c7c6a20 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseTransparentDataEncryption.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseTransparentDataEncryption.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 2328631F-BC30-40E3-ADF7-B1D3B46A6E34 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Gets the TDE state for a database. ``` Get-AzureRmSqlDatabaseTransparentDataEncryption [-ServerName] [-DatabaseName] - [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -54,6 +56,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group to which the database is assigned. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity.md index 2707ab238030..8ebef534cb48 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 7506FCEC-F96C-4918-8F20-A4B260F4DE1C online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Gets the progress of a TDE scan of a database. ``` Get-AzureRmSqlDatabaseTransparentDataEncryptionActivity [-ServerName] [-DatabaseName] - [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -55,6 +57,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group to which the database is assigned. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseUpgradeHint.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseUpgradeHint.md index 421819ccdc17..0acadcbb03c4 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseUpgradeHint.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlDatabaseUpgradeHint.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: D64FB139-04E2-47BC-86FB-EEEA23839F2F online version: schema: 2.0.0 @@ -14,8 +15,8 @@ Gets pricing tier hints for a database. ``` Get-AzureRmSqlDatabaseUpgradeHint [-ServerName] [-DatabaseName ] - [-ExcludeElasticPoolCandidates ] [-ResourceGroupName] [-WhatIf] [-Confirm] - [] + [-ExcludeElasticPoolCandidates ] [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -65,6 +66,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExcludeElasticPoolCandidates Indicates whether databases in elastic database pools are excluded from the returned recommendations. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPool.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPool.md index 2a68121fc007..30785fff28ca 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPool.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPool.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 350E19F6-5B1C-4D3F-B4CD-7225CDC984C4 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets elastic pools and their property values in an Azure SQL Database. ``` Get-AzureRmSqlElasticPool [[-ElasticPoolName] ] [-ServerName] [-ResourceGroupName] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -140,6 +141,21 @@ This command returns metrics for an Azure SQL elastic database pool named Elasti ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ElasticPoolName Specifies the name of the elastic pool that this cmdlet gets. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPoolActivity.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPoolActivity.md index e2e6def65a3c..20849c701587 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPoolActivity.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPoolActivity.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 0DB0B08A-F948-4F6E-9CF0-2FB5DD5064D3 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Gets the status of operations on an elastic pool. ``` Get-AzureRmSqlElasticPoolActivity [-ServerName] [-ElasticPoolName] - [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -32,6 +34,21 @@ This command gets the status of the operations for the elastic pool named Elasti ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ElasticPoolName Specifies the name of an elastic pool. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPoolAdvisor.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPoolAdvisor.md index c2b762757b6b..55c3b0c1745d 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPoolAdvisor.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPoolAdvisor.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: BC8C0D59-662F-47D2-8619-9F69D78B171D online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Gets one or more Advisors for an Azure SQL Elastic Pool. ``` Get-AzureRmSqlElasticPoolAdvisor [-AdvisorName ] [-ExpandRecommendedActions] -ServerName - -ElasticPoolName [-ResourceGroupName] [] + -ElasticPoolName [-ResourceGroupName] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -182,6 +184,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ElasticPoolName Specifies the name of the elastic pool for which this cmdlet requests the Advisor. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPoolDatabase.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPoolDatabase.md index 16181e600f0c..f70b1c23682d 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPoolDatabase.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPoolDatabase.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 14620FBD-4B10-4366-94F7-891BC01B893F online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Gets elastic databases in an elastic pool and their property values. ``` Get-AzureRmSqlElasticPoolDatabase [-ElasticPoolName] [-DatabaseName ] [-ServerName] - [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -47,6 +49,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ElasticPoolName Specifies the name of an elastic pool. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPoolRecommendation.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPoolRecommendation.md index 913b7d225c6f..c35470e19c2e 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPoolRecommendation.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPoolRecommendation.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: A1E19A66-CD70-467E-8C59-1F88453905A4 online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Gets elastic pool recommendations. ## SYNTAX ``` -Get-AzureRmSqlElasticPoolRecommendation [-ServerName] [-ResourceGroupName] [-WhatIf] - [-Confirm] [] +Get-AzureRmSqlElasticPoolRecommendation [-ServerName] [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -41,6 +42,21 @@ This command gets the elastic pool recommendations for the server named Server01 ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies name of the resource group to which the server is assigned. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPoolRecommendedAction.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPoolRecommendedAction.md index b820c266587c..a35eb4ecfad0 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPoolRecommendedAction.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlElasticPoolRecommendedAction.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 3FC9E586-3962-437E-B89F-BB4EA1FBF403 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Gets one or more recommended actions for an Azure SQL Elastic Pool Advisor. ``` Get-AzureRmSqlElasticPoolRecommendedAction [-RecommendedActionName ] -ServerName - -ElasticPoolName -AdvisorName [-ResourceGroupName] [] + -ElasticPoolName -AdvisorName [-ResourceGroupName] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -171,6 +173,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ElasticPoolName Specifies the name of the elastic pool for which this cmdlet requests recommended actions. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServer.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServer.md index 2dcfc8ef7c93..5fe87f78b421 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServer.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServer.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: C39ACCAC-2BFF-48D0-95EA-D5B402D74D46 online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Returns information about SQL Database servers. ## SYNTAX ``` -Get-AzureRmSqlServer [[-ServerName] ] [-ResourceGroupName] [-WhatIf] [-Confirm] - [] +Get-AzureRmSqlServer [[-ResourceGroupName] ] [[-ServerName] ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -90,6 +91,21 @@ This command gets information about all the Azure SQL Database servers in the cu ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group to which servers are assigned. @@ -98,7 +114,7 @@ Type: String Parameter Sets: (All) Aliases: -Required: True +Required: False Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerActiveDirectoryAdministrator.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerActiveDirectoryAdministrator.md index 0cf504bc3d14..7480f46580f2 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerActiveDirectoryAdministrator.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerActiveDirectoryAdministrator.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: FEDA14CF-632F-4D15-A22B-C73A1298094F online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Gets information about an Azure AD administrator for SQL Server. ## SYNTAX ``` -Get-AzureRmSqlServerActiveDirectoryAdministrator [-ServerName] [-ResourceGroupName] [-WhatIf] - [-Confirm] [] +Get-AzureRmSqlServerActiveDirectoryAdministrator [-ServerName] [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -34,6 +35,21 @@ This command gets information about an Azure AD administrator for a server named ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group to which the SQL Server is assigned. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerAdvisor.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerAdvisor.md index a1333556bc0f..99648740411d 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerAdvisor.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerAdvisor.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: DAEF11C1-281B-4BED-9283-2296E0B57018 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets one or more Advisors for an Azure SQL Server. ``` Get-AzureRmSqlServerAdvisor [-AdvisorName ] [-ExpandRecommendedActions] -ServerName - [-ResourceGroupName] [] + [-ResourceGroupName] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -171,6 +172,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExpandRecommendedActions Indicates that the cmdlet includes the recommended actions of the advisors that are included in the response. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerAuditing.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerAuditing.md index 53983fce57ea..5466d2d7dc40 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerAuditing.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerAuditing.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 14814BF3-51AF-4E51-A8A6-661825BD88D1 online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Gets the auditing settings of an Azure SQL server. ## SYNTAX ``` -Get-AzureRmSqlServerAuditing [-ServerName] [-ResourceGroupName] [-WhatIf] [-Confirm] - [] +Get-AzureRmSqlServerAuditing [-ServerName] [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -39,6 +40,21 @@ RetentionInDays : 0 ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +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. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerAuditingPolicy.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerAuditingPolicy.md index 1834fad0a815..3943c210cd95 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerAuditingPolicy.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerAuditingPolicy.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 40674DC7-E35F-4C9F-8CE0-D1C6F524C9FB online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Gets the auditing policy of a SQL server. ## SYNTAX ``` -Get-AzureRmSqlServerAuditingPolicy -ServerName [-ResourceGroupName] [-WhatIf] [-Confirm] - [] +Get-AzureRmSqlServerAuditingPolicy -ServerName [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -55,6 +56,21 @@ RetentionInDays : 0 ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group to which the Azure SQL server is assigned. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerBackupLongTermRetentionVault.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerBackupLongTermRetentionVault.md index e117701836a1..47ce5e46542e 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerBackupLongTermRetentionVault.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerBackupLongTermRetentionVault.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 686785F8-2085-4705-A74D-12B18A87E187 online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Gets a server long term retention vault. ## SYNTAX ``` -Get-AzureRmSqlServerBackupLongTermRetentionVault [-ServerName] [-ResourceGroupName] [-WhatIf] - [-Confirm] [] +Get-AzureRmSqlServerBackupLongTermRetentionVault [-ServerName] [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -30,6 +31,21 @@ The vault is an Azure Backup resource used to store backup data. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group that contains the server. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerCommunicationLink.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerCommunicationLink.md index 8d730b614369..b436171f3b1f 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerCommunicationLink.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerCommunicationLink.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 2E7E20CD-6A2B-455E-9476-8E0827429162 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Gets communication links for elastic database transactions between database serv ``` Get-AzureRmSqlServerCommunicationLink [[-LinkName] ] [-ServerName] - [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -39,6 +41,21 @@ This command gets the server-to-server communication link named Link01. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LinkName Specifies the name of the server communication link that this cmdlet gets. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerDisasterRecoveryConfiguration.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerDisasterRecoveryConfiguration.md index e4670fcff62c..2a33f969785e 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerDisasterRecoveryConfiguration.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerDisasterRecoveryConfiguration.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: C7F3E754-394A-4F93-A621-A07AF281EE45 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Gets a database server system recovery configuration. ``` Get-AzureRmSqlServerDisasterRecoveryConfiguration [-VirtualEndpointName ] [-ServerName] - [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -29,6 +31,21 @@ The **Get-AzureRmSqlServerDisasterRecoveryConfiguration** cmdlet gets a SQL data ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerDisasterRecoveryConfigurationActivity.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerDisasterRecoveryConfigurationActivity.md index b329cf9a1647..4ac2f48a5a97 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerDisasterRecoveryConfigurationActivity.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerDisasterRecoveryConfigurationActivity.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 41D63CC1-5E9F-48D3-89DE-0F753C7475F2 online version: schema: 2.0.0 @@ -15,7 +16,7 @@ Gets activity for a database server system recovery configuration. ``` Get-AzureRmSqlServerDisasterRecoveryConfigurationActivity [-ServerName] -ServerDisasterRecoveryConfigurationName [-OperationId ] [-ResourceGroupName] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -30,6 +31,21 @@ The **Get-AzureRmSqlServerDisasterRecoveryConfigurationActivity** cmdlet gets ac ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OperationId Specifies the operation ID. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerFirewallRule.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerFirewallRule.md index 62fac0b8fb3c..660629a35e4a 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerFirewallRule.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerFirewallRule.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: AD8BA5CB-D5D4-4C6E-A65F-E7AE69E3B22C online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Gets firewall rules for a SQL Database server. ``` Get-AzureRmSqlServerFirewallRule [[-FirewallRuleName] ] [-ServerName] - [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -43,6 +45,21 @@ This command gets all the firewall rules for the server named Server01. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -FirewallRuleName Specifies the name of the firewall rule. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerKeyVaultKey.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerKeyVaultKey.md index 338782c0fd0e..1d911f51d362 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerKeyVaultKey.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerKeyVaultKey.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -13,7 +14,7 @@ Gets a SQL server's Key Vault keys. ``` Get-AzureRmSqlServerKeyVaultKey [[-KeyId] ] [-ServerName] [-ResourceGroupName] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -55,6 +56,21 @@ You can inspect the properties of $MyServerKeyVaultKey to get details about the ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -KeyId The Azure Key Vault KeyId. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerRecommendedAction.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerRecommendedAction.md index ef5d9b1f9901..e36930d68650 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerRecommendedAction.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerRecommendedAction.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: BB513A53-48A0-4F8F-93F0-D3DFA2C3D523 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Gets one or more recommended actions for an Azure SQL Server Advisor. ``` Get-AzureRmSqlServerRecommendedAction [-RecommendedActionName ] -ServerName - -AdvisorName [-ResourceGroupName] [] + -AdvisorName [-ResourceGroupName] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -168,6 +170,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RecommendedActionName Specifies the name of the recommended action that this cmdlet gets. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerServiceObjective.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerServiceObjective.md index 751aad7fa82e..98c9020b4314 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerServiceObjective.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerServiceObjective.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: AC2D64B9-5BCD-45D3-8650-538633F5BBBC online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Gets service objectives for an Azure SQL Database server. ``` Get-AzureRmSqlServerServiceObjective [[-ServiceObjectiveName] ] [-ServerName] - [[-DatabaseName] ] [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [[-DatabaseName] ] [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -62,6 +64,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of a resource group. This cmdlet gets service objectives for a SQL Database server assigned to this resource. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerThreatDetectionPolicy.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerThreatDetectionPolicy.md index b486ba9cc61d..d286098bd8a2 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerThreatDetectionPolicy.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerThreatDetectionPolicy.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: F26CB715-D66A-4672-AA47-F3B316957FC8 online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Gets the threat detection policy for a server. ## SYNTAX ``` -Get-AzureRmSqlServerThreatDetectionPolicy -ServerName [-ResourceGroupName] [-WhatIf] - [-Confirm] [] +Get-AzureRmSqlServerThreatDetectionPolicy -ServerName [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -41,6 +42,21 @@ The server is assigned to the resource group ResourceGroup11. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group to which the server belongs. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerTransparentDataEncryptionProtector.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerTransparentDataEncryptionProtector.md index 00f0f1ac9c27..556639a09cb5 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerTransparentDataEncryptionProtector.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerTransparentDataEncryptionProtector.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -13,7 +14,7 @@ Gets the Transparent Data Encryption (TDE) protector ``` Get-AzureRmSqlServerTransparentDataEncryptionProtector [-ServerName] [-ResourceGroupName] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -34,6 +35,21 @@ ContosoResourceGroup ContosoServer ServiceManaged ServiceManaged ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +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 diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerUpgrade.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerUpgrade.md index 921651f9da5c..e2e53a54501f 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerUpgrade.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerUpgrade.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: B3776B0B-FBC8-407A-A8A4-583C346CCF12 online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Gets the status of an Azure SQL Database server upgrade. ## SYNTAX ``` -Get-AzureRmSqlServerUpgrade -ServerName [-ResourceGroupName] [-WhatIf] [-Confirm] - [] +Get-AzureRmSqlServerUpgrade -ServerName [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -34,6 +35,21 @@ This command gets the status of an upgrade from the server named Server01 in res ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group to which the server is assigned. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerUpgradeHint.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerUpgradeHint.md index 242adcb00c6c..ace562dd441b 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerUpgradeHint.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerUpgradeHint.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: BFEAE1F7-56E3-4EA9-B39A-ED09582C8A09 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Gets pricing tier hints for upgrading an Azure SQL Database server. ``` Get-AzureRmSqlServerUpgradeHint [-ServerName] [-ExcludeElasticPools ] - [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -37,6 +39,21 @@ This command gets combined recommendations for all the databases on a server nam ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExcludeElasticPools Indicates whether databases that are included in elastic database pools should be returned. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerVirtualNetworkRule.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerVirtualNetworkRule.md index b6a71a713495..2f5d7efa6728 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerVirtualNetworkRule.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerVirtualNetworkRule.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -13,7 +14,7 @@ Gets or lists Azure SQL Server Virtual Network Rule. ``` Get-AzureRmSqlServerVirtualNetworkRule [-VirtualNetworkRuleName ] -ServerName - [-ResourceGroupName] [-WhatIf] [-Confirm] + [-ResourceGroupName] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -35,9 +36,23 @@ PS C:\> $virtualNetworkRules = Get-AzureRmSqlServerVirtualNetworkRule -ResourceG Gets the list of Azure SQL Server virtual network rules under the specified server - ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +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. @@ -83,42 +98,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: 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: 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 - ## OUTPUTS ### Microsoft.Azure.Commands.Sql.VirtualNetworkRule.Model.AzureSqlServerVirtualNetworkRuleModel diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncAgent.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncAgent.md index ea3121cefd80..065a55e73d37 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncAgent.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncAgent.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -10,8 +11,10 @@ schema: 2.0.0 Returns information about Azure SQL Sync Agents. ## SYNTAX + ``` Get-AzureRmSqlSyncAgent [[-Name] ] [-ServerName] [-ResourceGroupName] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -70,6 +73,21 @@ This command gets information about the Azure SQL Database Sync Agent with name ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name The sync agent name. @@ -115,6 +133,9 @@ Accept pipeline input: True (ByPropertyName) 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 diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncAgentLinkedDatabase.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncAgentLinkedDatabase.md index 1612724d4c73..4af1f4316480 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncAgentLinkedDatabase.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncAgentLinkedDatabase.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -13,7 +14,7 @@ Returns information about SQL Server databases linked by a sync agent. ``` Get-AzureRmSqlSyncAgentLinkedDatabase [-ServerName] [-SyncAgentName] - [-ResourceGroupName] + [-ResourceGroupName] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -34,9 +35,23 @@ UserName : myAccount This command returns the linked SQL Server databases linked by an Azure SQL sync agent. - ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +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. @@ -82,11 +97,14 @@ Accept pipeline input: True (ByPropertyName) 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.Commands.Sql.DataSync.Model.AzureSqlSyncAgentLinkedDatabaseModel +### Microsoft.Azure.Commands.Sql.DataSync.Model.AzureSqlSyncAgentLinkedDatabaseModel ## NOTES diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncGroup.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncGroup.md index ac52cadb5e14..0588622824fb 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncGroup.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncGroup.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -13,7 +14,7 @@ Returns information about Azure SQL Database Sync Groups. ``` Get-AzureRmSqlSyncGroup [[-Name] ] [-ServerName] [-DatabaseName] - [-ResourceGroupName] + [-ResourceGroupName] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -22,7 +23,6 @@ Specify the name of a sync group to see information for only that sync group. ## EXAMPLES - ### Example 1: Get all instances of Azure SQL Sync Group assigned to an Azure SQL Database ``` PS C:\>Get-AzureRmSqlSyncGroup -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01" | Format-List @@ -52,7 +52,7 @@ HubDatabaseUserName : myAccount HubDatabasePassword : SyncState : NotReady LastSyncTime : 1/1/0001 12:00:00 AM -Schema : +Schema : ``` This command gets information about all the Azure SQL Database Sync Groups assigned to an Azure SQL Database. @@ -72,7 +72,7 @@ HubDatabaseUserName : myAccount HubDatabasePassword : SyncState : NotReady LastSyncTime : 1/1/0001 12:00:00 AM -Schema : +Schema : ``` This command gets information about the Azure SQL Database Sync Group with name "SyncGroup01" @@ -94,6 +94,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name The sync group name. @@ -139,6 +154,9 @@ Accept pipeline input: True (ByPropertyName) 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 diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncGroupLog.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncGroupLog.md index 72cafe24a726..e9fdf03b54fb 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncGroupLog.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncGroupLog.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -14,6 +15,7 @@ Returns the logs of an Azure SQL Database Sync Group. ``` Get-AzureRmSqlSyncGroupLog [-SyncGroupName] -StartTime [-EndTime ] [-LogLevel ] [-ServerName] [-DatabaseName] [-ResourceGroupName] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -49,13 +51,13 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -EndTime -The end time of the logs to query. +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure ```yaml -Type: DateTime +Type: IAzureContextContainer Parameter Sets: (All) -Aliases: +Aliases: AzureRmContext, AzureCredential Required: False Position: Named @@ -64,15 +66,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LogLevel -The type of the logs to query. -Valid values are: 'Error', 'Warning', 'Success' and 'All'. +### -EndTime +The end time of the logs to query. ```yaml -Type: String +Type: DateTime Parameter Sets: (All) Aliases: -Accepted values: Error, Warning, Success, All Required: False Position: Named @@ -81,18 +81,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncGroupName -The sync group name. +### -LogLevel +The type of the logs to query. +Valid values are: 'Error', 'Warning', 'Success' and 'All'. ```yaml Type: String Parameter Sets: (All) -Aliases: Name +Aliases: +Accepted values: Error, Warning, Success, All -Required: True -Position: 3 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -141,6 +143,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SyncGroupName +The sync group name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Name + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +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 diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncMember.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncMember.md index c38abfa7ebf6..38bd3d482515 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncMember.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncMember.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -13,7 +14,8 @@ Returns information about Azure SQL Database Sync Members. ``` Get-AzureRmSqlSyncMember [-Name ] [-SyncGroupName] [-ServerName] - [-DatabaseName] [-ResourceGroupName] + [-DatabaseName] [-ResourceGroupName] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -55,7 +57,7 @@ MemberServerName : memberServer01.full.dns.name MemberDatabaseName : memberDatabase01 MemberDatabaseUserName : myAccount MemberDatabasePassword : -SyncState : Good +SyncState : Good ``` This command gets information about all the Azure SQL Database Sync Member assigned to the sync group SyncGroup01. @@ -77,7 +79,7 @@ MemberServerName : memberServer01.full.dns.name MemberDatabaseName : memberDatabase01 MemberDatabaseUserName : myAccount MemberDatabasePassword : -SyncState : Good +SyncState : Good ``` This command gets information about the Azure SQL Database Sync Member with name "SyncMember01" @@ -99,6 +101,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name The sync member name. @@ -159,6 +176,9 @@ Accept pipeline input: True (ByPropertyName) 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 diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncSchema.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncSchema.md index e67eddfc18cb..89a6854fa5ee 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncSchema.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlSyncSchema.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -13,7 +14,8 @@ Returns information about the sync schema of a member database or a hub database ``` Get-AzureRmSqlSyncSchema [-SyncGroupName] [-SyncMemberName ] [-ServerName] - [-DatabaseName] [-ResourceGroupName] + [-DatabaseName] [-ResourceGroupName] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -31,7 +33,6 @@ Tables LastUpdateTime This command gets the sync schema for the hub database in the sync group syncGroup01. - ### Example 1.2: Get the sync schema for a hub database, and expand Tables ``` PS C:\>Get-AzureRmSqlSyncSchema -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "database01" -SyncGroupName "syncGroup01" | select -ExpandProperty Tables @@ -50,14 +51,13 @@ QuotedName : [dbo].[Table_2] This command gets the sync schema for the hub database in the sync group syncGroup01 and expand Tables property. - ### Example 2: Get the sync schema for a member database ``` PS C:\>Get-AzureRmSqlSyncSchema -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "database01" -SyncGroupName "syncGroup01" -SyncMemberName "syncMember01" The schema payload is the same as Example 1. ``` -This command gets the sync schema for the member database in the sync member syncMember01. +This command gets the sync schema for the member database in the sync member syncMember01. ## PARAMETERS @@ -76,6 +76,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +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. @@ -136,6 +151,9 @@ Accept pipeline input: True (ByPropertyName) 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 diff --git a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabase.md b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabase.md index 6a0f13bc0c55..93145ad4073b 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabase.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabase.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: D2DB7821-A7D2-4017-8522-78793DDE040E -online version: +online version: schema: 2.0.0 --- @@ -16,7 +17,8 @@ Creates a database or an elastic database. New-AzureRmSqlDatabase -DatabaseName [-CollationName ] [-CatalogCollation ] [-MaxSizeBytes ] [-Edition ] [-RequestedServiceObjectiveName ] [-ElasticPoolName ] [-ReadScale ] [-Tags ] [-SampleName ] - [-ServerName] [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ServerName] [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -84,7 +86,7 @@ Specifies the name of the SQL database catalog collation. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -99,7 +101,7 @@ Specifies the name of the SQL database collation. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -123,6 +125,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Edition Specifies the edition to assign to the database. The acceptable values for this parameter are: @@ -137,7 +154,7 @@ Specifies the edition to assign to the database. The acceptable values for this ```yaml Type: DatabaseEdition Parameter Sets: (All) -Aliases: +Aliases: Accepted values: None, Premium, Basic, Standard, DataWarehouse, Stretch, Free, PremiumRS Required: False @@ -153,7 +170,7 @@ Specifies the name of the elastic pool in which to put the database. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -168,7 +185,7 @@ Specifies the maximum size of the database in bytes. ```yaml Type: Int64 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -183,7 +200,7 @@ The read scale option to assign to the Azure SQL Database.(Enabled/Disabled) ```yaml Type: DatabaseReadScale Parameter Sets: (All) -Aliases: +Aliases: Accepted values: Disabled, Enabled Required: False @@ -199,7 +216,7 @@ Specifies the name of the service objective to assign to the database. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -214,7 +231,7 @@ Specifies the name of the resource group to which the server is assigned. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -229,7 +246,7 @@ The name of the sample schema to apply when creating this database. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Accepted values: AdventureWorksLT Required: False @@ -245,7 +262,7 @@ Specifies the name of the server that hosts the database. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 diff --git a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseCopy.md b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseCopy.md index 92ac318d75d8..babc2bb94aa4 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseCopy.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseCopy.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: CED38886-2DC9-450E-91FF-8209602C76CD -online version: +online version: schema: 2.0.0 --- @@ -15,8 +16,8 @@ Creates a copy of a SQL Database that uses the snapshot at the current time. ``` New-AzureRmSqlDatabaseCopy [-DatabaseName] [-ServiceObjectiveName ] [-ElasticPoolName ] [-Tags ] [-CopyResourceGroupName ] [-CopyServerName ] - -CopyDatabaseName [-ServerName] [-ResourceGroupName] [-WhatIf] [-Confirm] - [] + -CopyDatabaseName [-ServerName] [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -43,7 +44,7 @@ Specifies the name of the SQL Database copy. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -58,7 +59,7 @@ Specifies the name of the Azure Resource Group in which to assign the copy. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -73,7 +74,7 @@ Specifies the name of the SQL Server which hosts the copy. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -88,7 +89,7 @@ Specifies the name of the SQL Database to copy. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 2 @@ -97,13 +98,28 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ElasticPoolName Specifies the name of the elastic pool in which to assign the copy. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -118,7 +134,7 @@ Specifies the name of the Resource Group to which this cmdlet assigns the copie ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -133,7 +149,7 @@ Specifies the name of the SQL Server that contains the database to copy. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -148,7 +164,7 @@ Specifies the name of the service objective to assign to the copy. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -213,7 +229,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.Commands.Sql.Replication.Model.AzureSqlDatabaseCopyModel - This cmdlet returns a **Database** object that represents the copied database. ## NOTES diff --git a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseDataMaskingRule.md b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseDataMaskingRule.md index 2ab9d141b1e8..a7d4fc7df899 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseDataMaskingRule.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseDataMaskingRule.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: A123CB7F-2F95-49EE-9F57-E264EB1F9093 online version: schema: 2.0.0 @@ -16,7 +17,8 @@ Creates a data masking rule for a database. New-AzureRmSqlDatabaseDataMaskingRule -MaskingFunction [-PrefixSize ] [-ReplacementString ] [-SuffixSize ] [-NumberFrom ] [-NumberTo ] [-PassThru] -SchemaName -TableName -ColumnName [-ServerName] [-DatabaseName] - [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -75,6 +77,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MaskingFunction Specifies the masking function that the rule uses. The acceptable values for this parameter are: diff --git a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseExport.md b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseExport.md index c0029b02ae3c..a884494f0b2b 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseExport.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseExport.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 3D4822DD-736B-42DF-8D9A-1CB23FEF052E online version: schema: 2.0.0 @@ -15,8 +16,8 @@ Exports an Azure SQL Database as a .bacpac file to a storage account. ``` New-AzureRmSqlDatabaseExport [-DatabaseName] [-ServerName] -StorageKeyType -StorageKey -StorageUri -AdministratorLogin -AdministratorLoginPassword - [-AuthenticationType ] [-ResourceGroupName] [-WhatIf] [-Confirm] - [] + [-AuthenticationType ] [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -122,6 +123,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group for the SQL Database server. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseFailoverGroup.md b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseFailoverGroup.md index c6e6f2080b08..eb5056ff85b3 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseFailoverGroup.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseFailoverGroup.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -15,7 +16,7 @@ This command creates a new Azure SQL Database Failover Group. New-AzureRmSqlDatabaseFailoverGroup [-ServerName] -FailoverGroupName [-PartnerResourceGroupName ] -PartnerServerName [-FailoverPolicy ] [-GracePeriodWithDataLossHours ] [-AllowReadOnlyFailoverToPrimary ] - [-ResourceGroupName] [] + [-ResourceGroupName] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -61,6 +62,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -FailoverGroupName The name of the Azure SQL Database Failover Group to create. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseImport.md b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseImport.md index 5a5cc07596ca..0409f7bce597 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseImport.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseImport.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: A1327BC6-F090-490E-8DC2-2CC48A21C2C0 online version: schema: 2.0.0 @@ -16,8 +17,8 @@ Imports a .bacpac file and create a new database on the server. New-AzureRmSqlDatabaseImport -DatabaseName -Edition -ServiceObjectiveName -DatabaseMaxSizeBytes [-ServerName] -StorageKeyType -StorageKey -StorageUri -AdministratorLogin -AdministratorLoginPassword - [-AuthenticationType ] [-ResourceGroupName] [-WhatIf] [-Confirm] - [] + [-AuthenticationType ] [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -136,6 +137,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Edition Specifies the edition of the new database to import to. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseSecondary.md b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseSecondary.md index 42d9b178b0f8..f756c548980d 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseSecondary.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlDatabaseSecondary.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: BEE99039-35F7-4E9D-9308-090EAE68292D -online version: +online version: schema: 2.0.0 --- @@ -16,7 +17,8 @@ Creates a secondary database for an existing database and starts data replicatio New-AzureRmSqlDatabaseSecondary [-DatabaseName] [-SecondaryServiceObjectiveName ] [-SecondaryElasticPoolName ] [-Tags ] -PartnerResourceGroupName -PartnerServerName [-AllowConnections ] [-ServerName] - [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -44,7 +46,7 @@ The acceptable values for this parameter are: ```yaml Type: AllowConnections Parameter Sets: (All) -Aliases: +Aliases: Accepted values: No, All Required: False @@ -60,7 +62,7 @@ Specifies the name of the database to act as primary. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 2 @@ -69,13 +71,28 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PartnerResourceGroupName Specifies the name of the Azure Resource Group to which this cmdlet assigns the secondary database. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -90,7 +107,7 @@ Specifies the name of the Azure SQL database server to act as secondary. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -105,7 +122,7 @@ Specifies the name of the Azure Resource Group to which this cmdlet assigns the ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -120,7 +137,7 @@ Specifies the name of the elastic pool in which to put the secondary database. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -135,7 +152,7 @@ Specifies the name of the service objective to assign to the secondary database. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -150,7 +167,7 @@ Specifies the name of the SQL Server of the primary SQL Database. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -215,7 +232,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.Commands.Sql.Replication.Model.AzureReplicationLinkModel - This cmdlet returns **ReplicationLink** objects. ## NOTES diff --git a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlElasticPool.md b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlElasticPool.md index 577fd7162b96..cb5c85b42703 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlElasticPool.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlElasticPool.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 009899E5-83BF-4A3F-877E-70C16D5CD1AC -online version: +online version: schema: 2.0.0 --- @@ -15,7 +16,8 @@ Creates an elastic database pool for a SQL Database. ``` New-AzureRmSqlElasticPool -ElasticPoolName [-Edition ] [-Dtu ] [-StorageMB ] [-DatabaseDtuMin ] [-DatabaseDtuMax ] [-Tags ] - [-ServerName] [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ServerName] [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -63,7 +65,7 @@ For details about which values are valid, see the table for your specific size p ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -81,7 +83,22 @@ For details about which values are valid, see the table for your specific size p ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +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: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential Required: False Position: Named @@ -106,7 +123,7 @@ For details about which values are valid, see the table for your specific size p ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -130,7 +147,7 @@ The acceptable values for this parameter are: ```yaml Type: DatabaseEdition Parameter Sets: (All) -Aliases: +Aliases: Accepted values: None, Premium, Basic, Standard, DataWarehouse, Stretch, Free, PremiumRS Required: False @@ -161,7 +178,7 @@ Specifies the name of the resource group to which this cmdlet assigns the elasti ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -176,7 +193,7 @@ Specifies the name of the server that hosts the elastic pool. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -186,7 +203,6 @@ Accept wildcard characters: False ``` ### -StorageMB - Specifies the storage limit, in megabytes, for the elastic pool. If you do not specify this parameter, this cmdlet calculates a value that depends on the value of the *Dtu* parameter. @@ -195,7 +211,7 @@ See [eDTU and storage limits](/azure/sql-database/sql-database-elastic-pool#edtu ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named diff --git a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServer.md b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServer.md index 09985175f68e..900a6284d255 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServer.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServer.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 7039528F-42AE-45DB-BF81-FE5003F8AEE2 -online version: +online version: schema: 2.0.0 --- @@ -14,8 +15,8 @@ Creates a SQL Database server. ``` New-AzureRmSqlServer -ServerName -SqlAdministratorCredentials -Location - [-Tags ] [-ServerVersion ] [-AssignIdentity] [-ResourceGroupName] [-WhatIf] - [-Confirm] [] + [-Tags ] [-ServerVersion ] [-AssignIdentity] [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,7 +46,22 @@ Generate and assign an Azure Active Directory Identity for this server for use w ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +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: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential Required: False Position: Named @@ -60,7 +76,7 @@ Specifies the location of the data center where this cmdlet creates the server. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named @@ -75,7 +91,7 @@ Specifies the name of the resource group to which this cmdlet assigns the server ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -107,7 +123,7 @@ Specify 2.0 to create a version 11 server, or 12.0 to create a version 12 server ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -124,7 +140,7 @@ Get-Credential`. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: Named diff --git a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServerCommunicationLink.md b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServerCommunicationLink.md index 3c0c1d0180db..ba8156f6f603 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServerCommunicationLink.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServerCommunicationLink.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 52664E45-7EAB-41C9-BF78-304F10BFC51A online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Creates a communication link for elastic database transactions between two SQL D ``` New-AzureRmSqlServerCommunicationLink -LinkName -PartnerServer [-ServerName] - [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -34,6 +36,21 @@ This command creates a link named Link01 between ContosoServer17 and ContosoServ ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LinkName Specifies the name of the server communication link that this cmdlet creates. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServerDisasterRecoveryConfiguration.md b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServerDisasterRecoveryConfiguration.md index 81ec640e92f0..6c3d26f93dbd 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServerDisasterRecoveryConfiguration.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServerDisasterRecoveryConfiguration.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 1D8E8599-113C-4852-8416-1F3359071047 online version: schema: 2.0.0 @@ -15,7 +16,8 @@ Creates a database server system recovery configuration. ``` New-AzureRmSqlServerDisasterRecoveryConfiguration -VirtualEndpointName -PartnerResourceGroupName -PartnerServerName [-FailoverPolicy ] - [-ServerName] [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ServerName] [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -30,6 +32,21 @@ The **New-AzureRmSqlServerDisasterRecoveryConfiguration** cmdlet creates a SQL d ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -FailoverPolicy Specifies the failover policy. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServerFirewallRule.md b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServerFirewallRule.md index 5441c020d3e3..41b635047dc8 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServerFirewallRule.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServerFirewallRule.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 51AF8EFB-F0C1-41E0-BBC5-E48FB1B8672C online version: schema: 2.0.0 @@ -15,13 +16,14 @@ Creates a firewall rule for a SQL Database server. ### UserSpecifiedRuleSet ``` New-AzureRmSqlServerFirewallRule -FirewallRuleName -StartIpAddress -EndIpAddress - [-ServerName] [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ServerName] [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ### AzureIpRuleSet ``` New-AzureRmSqlServerFirewallRule [-AllowAllAzureIPs] [-ServerName] [-ResourceGroupName] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -69,6 +71,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EndIpAddress Specifies the end value of the IP address range for this rule. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServerVirtualNetworkRule.md b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServerVirtualNetworkRule.md index 14af45e7f3ee..5cb4cf3d4d6c 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServerVirtualNetworkRule.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlServerVirtualNetworkRule.md @@ -33,7 +33,7 @@ Creates an Azure SQL Server virtual network rule ## PARAMETERS ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. +The credentials, account, tenant, and subscription used for communication with azure ```yaml Type: IAzureContextContainer diff --git a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlSyncAgent.md b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlSyncAgent.md index 16f3ce63f4d0..82e6733760be 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlSyncAgent.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlSyncAgent.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -14,14 +15,15 @@ Creates an Azure SQL Sync Agent. ### SyncDatabaseComponent (Default) ``` New-AzureRmSqlSyncAgent [-Name] -SyncDatabaseName [-SyncDatabaseServerName ] - [-SyncDatabaseResourceGroupName ] [-ServerName] [-ResourceGroupName] [-WhatIf] - [-Confirm] + [-SyncDatabaseResourceGroupName ] [-ServerName] [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### SyncDatabaseResourceID ``` New-AzureRmSqlSyncAgent [-Name] -SyncDatabaseResourceID [-ServerName] - [-ResourceGroupName] [-WhatIf] [-Confirm] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -50,13 +52,13 @@ This command creates a sync agent for an Azure SQL server. ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure ```yaml -Type: SwitchParameter +Type: IAzureContextContainer Parameter Sets: (All) -Aliases: cf +Aliases: AzureRmContext, AzureCredential Required: False Position: Named @@ -170,6 +172,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: 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. @@ -186,6 +203,9 @@ 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 diff --git a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlSyncAgentKey.md b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlSyncAgentKey.md index f5ebe172a978..bc197d84519e 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlSyncAgentKey.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlSyncAgentKey.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -13,7 +14,7 @@ Creates an Azure SQL Sync Agent Key. ``` New-AzureRmSqlSyncAgentKey [-ServerName] [-SyncAgentName] [-ResourceGroupName] - [-WhatIf] [-Confirm] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -31,13 +32,13 @@ This command creates a sync agent key for an Azure SQL Sync Agent. ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure ```yaml -Type: SwitchParameter +Type: IAzureContextContainer Parameter Sets: (All) -Aliases: cf +Aliases: AzureRmContext, AzureCredential Required: False Position: Named @@ -91,6 +92,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: 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. @@ -107,6 +123,9 @@ 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 diff --git a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlSyncGroup.md b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlSyncGroup.md index 838643d6ca90..23184fed6350 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlSyncGroup.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlSyncGroup.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -15,7 +16,8 @@ Creates an Azure SQL Database Sync Group. New-AzureRmSqlSyncGroup [-Name] -SyncDatabaseName -SyncDatabaseServerName -SyncDatabaseResourceGroupName [-IntervalInSeconds ] [-DatabaseCredential ] [-ConflictResolutionPolicy ] [-SchemaFile ] [-ServerName] [-DatabaseName] - [-ResourceGroupName] [-WhatIf] [-Confirm] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -41,7 +43,7 @@ HubDatabaseUserName : myAccount HubDatabasePassword : SyncState : NotReady LastSyncTime : 1/1/0001 12:00:00 AM -Schema : +Schema : ``` This command creates a sync group for an Azure SQL Database. "schema.json" is a file in the local disk. It contains the shema payload in json format. An example of the schema json is: @@ -52,13 +54,14 @@ This command creates a sync group for an Azure SQL Database. "schema.json" is a ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -ConflictResolutionPolicy +The policy of resolving confliction between hub and member database in the sync group. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: +Accepted values: HubWin, MemberWin Required: False Position: Named @@ -67,14 +70,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConflictResolutionPolicy -The policy of resolving confliction between hub and member database in the sync group. +### -DatabaseCredential +The SQL authentication credential of the hub database. ```yaml -Type: String +Type: PSCredential Parameter Sets: (All) Aliases: -Accepted values: HubWin, MemberWin Required: False Position: Named @@ -98,13 +100,13 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -DatabaseCredential -The SQL authentication credential of the hub database. +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure ```yaml -Type: PSCredential +Type: IAzureContextContainer Parameter Sets: (All) -Aliases: +Aliases: AzureRmContext, AzureCredential Required: False Position: Named @@ -234,6 +236,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: 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. @@ -250,6 +267,9 @@ 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 diff --git a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlSyncMember.md b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlSyncMember.md index 66c59d369825..77315cb47279 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlSyncMember.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/New-AzureRmSqlSyncMember.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -9,7 +10,6 @@ schema: 2.0.0 ## SYNOPSIS Creates an Azure SQL Database Sync Member. - ## SYNTAX ### AzureSqlDatabase (Default) @@ -17,7 +17,7 @@ Creates an Azure SQL Database Sync Member. New-AzureRmSqlSyncMember -Name -MemberDatabaseType -MemberServerName -MemberDatabaseName -MemberDatabaseCredential [-SyncDirection ] [-SyncGroupName] [-ServerName] [-DatabaseName] [-ResourceGroupName] - [-WhatIf] [-Confirm] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### OnPremisesDatabaseSyncAgentComponent @@ -25,14 +25,15 @@ New-AzureRmSqlSyncMember -Name -MemberDatabaseType -MemberServ New-AzureRmSqlSyncMember -Name -MemberDatabaseType -SyncAgentResourceGroupName -SyncAgentServerName -SyncAgentName -SqlServerDatabaseId [-SyncDirection ] [-SyncGroupName] [-ServerName] [-DatabaseName] [-ResourceGroupName] - [-WhatIf] [-Confirm] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### OnPremisesDatabaseSyncAgentResourceID ``` New-AzureRmSqlSyncMember -Name -MemberDatabaseType -SqlServerDatabaseId -SyncAgentResourceID [-SyncDirection ] [-SyncGroupName] [-ServerName] - [-DatabaseName] [-ResourceGroupName] [-WhatIf] [-Confirm] + [-DatabaseName] [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -59,7 +60,7 @@ MemberServerName : memberServer01.full.dns.name MemberDatabaseName : memberDatabase01 MemberDatabaseUserName : myAccount MemberDatabasePassword : -SyncState : UnProvisioned +SyncState : UnProvisioned ``` This command creates a sync member for an Azure SQL database. @@ -84,40 +85,40 @@ MemberServerName : MemberDatabaseName : MemberDatabaseUserName : myAccount MemberDatabasePassword : -SyncState : UnProvisioned +SyncState : UnProvisioned ``` This command creates a sync member for an on-premises SQL database. ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -DatabaseName +The name of the Azure SQL Database. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -DatabaseName -The name of the Azure SQL Database. +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure ```yaml -Type: String +Type: IAzureContextContainer Parameter Sets: (All) -Aliases: +Aliases: AzureRmContext, AzureCredential -Required: True -Position: 2 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -333,6 +334,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: 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. @@ -349,6 +365,9 @@ 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 diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabase.md b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabase.md index 7f7936868547..630b3e1be756 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabase.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabase.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: B396388D-F91C-4BC9-A211-ABFF5DFC1693 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Removes an Azure SQL database. ``` Remove-AzureRmSqlDatabase [-DatabaseName] [-Force] [-ServerName] - [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -48,6 +50,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseAuditing.md b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseAuditing.md index 7411b83a9787..56c0a924b77b 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseAuditing.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseAuditing.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: D3BA6534-CAAC-41E2-8442-0606B712E2B8 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Removes the auditing of a database. ``` Remove-AzureRmSqlDatabaseAuditing [-PassThru] [-ServerName] [-DatabaseName] - [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -55,6 +57,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PassThru Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseDataMaskingRule.md b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseDataMaskingRule.md index bca9e633a7b2..cc47dff7e7be 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseDataMaskingRule.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseDataMaskingRule.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 4695AFEA-D244-4FCB-AF36-D8CDEBFB392C online version: schema: 2.0.0 @@ -14,8 +15,8 @@ Removes a data masking rule from a database. ``` Remove-AzureRmSqlDatabaseDataMaskingRule [-PassThru] [-Force] -SchemaName -TableName - -ColumnName [-ServerName] [-DatabaseName] [-ResourceGroupName] [-WhatIf] - [-Confirm] [] + -ColumnName [-ServerName] [-DatabaseName] [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -66,6 +67,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseFailoverGroup.md b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseFailoverGroup.md index e943bd65b3c4..34d44ae6fe3a 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseFailoverGroup.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseFailoverGroup.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -13,7 +14,8 @@ Removes an Azure SQL Database Failover Group. ``` Remove-AzureRmSqlDatabaseFailoverGroup [-ServerName] [-FailoverGroupName] [-Force] - [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -32,6 +34,21 @@ Remove a Failover Group. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -FailoverGroupName The name of the Azure SQL Database Failover Group to remove. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseFromFailoverGroup.md b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseFromFailoverGroup.md index e4a6d8ef0fff..d9a28d2411a3 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseFromFailoverGroup.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseFromFailoverGroup.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -14,7 +15,8 @@ Removes one or more databases from an Azure SQL Database Failover Group. ``` Remove-AzureRmSqlDatabaseFromFailoverGroup [-ServerName] [-FailoverGroupName] -Database - [-Force] [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-Force] [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -67,6 +69,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -FailoverGroupName The name of the Azure SQL Database Failover Group. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseSecondary.md b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseSecondary.md index d3552f9a8621..531b5b201da2 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseSecondary.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseSecondary.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 54E01B3B-FFA5-4E3C-BA5A-A281FF5C9F8B online version: schema: 2.0.0 @@ -14,8 +15,8 @@ Terminates data replication between a SQL Database and the specified secondary d ``` Remove-AzureRmSqlDatabaseSecondary [-DatabaseName] -PartnerResourceGroupName - -PartnerServerName [-ServerName] [-ResourceGroupName] [-WhatIf] [-Confirm] - [] + -PartnerServerName [-ServerName] [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -47,6 +48,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PartnerResourceGroupName Specifies the name of the partner resource group. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseThreatDetectionPolicy.md b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseThreatDetectionPolicy.md index 6f0f708c8dcf..e9d4157da543 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseThreatDetectionPolicy.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlDatabaseThreatDetectionPolicy.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: FCCB768A-A034-44AF-B4B6-2AD3133B08EF online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Removes the threat detection policy from a database. ``` Remove-AzureRmSqlDatabaseThreatDetectionPolicy [-PassThru] [-ServerName] [-DatabaseName] - [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -47,6 +49,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PassThru Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlElasticPool.md b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlElasticPool.md index 4233ec9b2438..d69a1384b1db 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlElasticPool.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlElasticPool.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 47E8E8C1-A63D-4243-A004-ABD5CA1A559E online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Deletes an elastic database pool. ``` Remove-AzureRmSqlElasticPool [-ElasticPoolName] [-Force] [-ServerName] - [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -31,6 +33,21 @@ This command deletes an elastic pool named ElasticPool01. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ElasticPoolName Specifies the name of the elastic pool that this cmdlet deletes. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServer.md b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServer.md index 062e1f79d51a..c4f834028dd8 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServer.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServer.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 068D70EF-39D1-4199-BD74-0EC266DF7072 online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Removes an Azure SQL Database server. ## SYNTAX ``` -Remove-AzureRmSqlServer [-ServerName] [-Force] [-ResourceGroupName] [-WhatIf] [-Confirm] - [] +Remove-AzureRmSqlServer [-ServerName] [-Force] [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -34,6 +35,21 @@ This command removes the Azure SQL Database server named Server01. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerActiveDirectoryAdministrator.md b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerActiveDirectoryAdministrator.md index 2101ba48d7f0..0b339ad9daeb 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerActiveDirectoryAdministrator.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerActiveDirectoryAdministrator.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: B2E6E66A-1A09-4DB0-8BB4-D2E5EC34C9EB online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Removes an Azure AD administrator for SQL Server. ``` Remove-AzureRmSqlServerActiveDirectoryAdministrator [-Force] [-ServerName] - [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -38,6 +40,21 @@ This command removes the Azure AD administrator for the server named Server01 as ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerAuditing.md b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerAuditing.md index 3aff7824185b..7c53fce73687 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerAuditing.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerAuditing.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 692D0B64-95EB-4D36-975F-65674B3B2F8C online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Removes the auditing of a SQL server. ## SYNTAX ``` -Remove-AzureRmSqlServerAuditing [-PassThru] -ServerName [-ResourceGroupName] [-WhatIf] - [-Confirm] [] +Remove-AzureRmSqlServerAuditing [-PassThru] -ServerName [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -35,6 +36,21 @@ This command removes the auditing of all the databases located on Server01 in re ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PassThru Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerCommunicationLink.md b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerCommunicationLink.md index 1be99b571386..d83a742967e5 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerCommunicationLink.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerCommunicationLink.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 48D6288A-EBE1-44FD-B871-80A0681BBEA3 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Deletes a communication link for elastic database transactions between two serve ``` Remove-AzureRmSqlServerCommunicationLink [-LinkName] [-Force] [-ServerName] - [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -31,6 +33,21 @@ This command deletes a server-to-server communication link named Link01 on Conto ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerDisasterRecoveryConfiguration.md b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerDisasterRecoveryConfiguration.md index 2c479c6ef817..9d7a25f3ec53 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerDisasterRecoveryConfiguration.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerDisasterRecoveryConfiguration.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 2A74E72B-BD6B-45D7-9C19-B2575C60C43F online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Removes a SQL database server system recovery configuration. ``` Remove-AzureRmSqlServerDisasterRecoveryConfiguration [-VirtualEndpointName] [-Force] - [-ServerName] [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ServerName] [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -29,6 +31,21 @@ The **Remove-AzureRmSqlServerDisasterRecoveryConfiguration** cmdlet removes a SQ ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerFirewallRule.md b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerFirewallRule.md index 2671cecebe83..c1071a7f971d 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerFirewallRule.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerFirewallRule.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 251A4546-AC23-4880-B197-773B1B814607 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Deletes a firewall rule from a SQL Database server. ``` Remove-AzureRmSqlServerFirewallRule [-FirewallRuleName] [-Force] [-ServerName] - [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -31,6 +33,21 @@ This command deletes a firewall rule named Rule01 on the server named Server01. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -FirewallRuleName Specifies the name of the firewall rule that this cmdlet deletes. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerKeyVaultKey.md b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerKeyVaultKey.md index f91ef36528b4..5669cf7167dd 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerKeyVaultKey.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerKeyVaultKey.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -13,7 +14,7 @@ Removes a Key Vault key from a SQL server. ``` Remove-AzureRmSqlServerKeyVaultKey [-KeyId] [-ServerName] [-ResourceGroupName] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -44,6 +45,21 @@ CreationDate : 1/1/2017 12:00:00 AM ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -KeyId The Azure Key Vault KeyId. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerThreatDetectionPolicy.md b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerThreatDetectionPolicy.md index aa5ba0d90308..a818533ee5e6 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerThreatDetectionPolicy.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerThreatDetectionPolicy.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: DCAB75A1-B4EF-4C41-9D6B-A954B6DB0028 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Removes the threat detection policy from a server. ``` Remove-AzureRmSqlServerThreatDetectionPolicy [-PassThru] -ServerName [-ResourceGroupName] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -33,6 +34,21 @@ This command removes the threat detection policy from a server named Server01. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PassThru Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerVirtualNetworkRule.md b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerVirtualNetworkRule.md index b991a9618625..b9e1714a4c40 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerVirtualNetworkRule.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerVirtualNetworkRule.md @@ -33,7 +33,8 @@ Deletes an existing Azure SQL Server virtual network rule ## PARAMETERS ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. +The credentials, account, tenant, and subscription used for communication with azure + ```yaml Type: IAzureContextContainer diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlSyncAgent.md b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlSyncAgent.md index 98c5a0e3e41b..a16c0b4f28a0 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlSyncAgent.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlSyncAgent.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -13,7 +14,8 @@ Removes an Azure SQL Sync Agent. ``` Remove-AzureRmSqlSyncAgent [-Name] [-Force] [-PassThru] [-ServerName] - [-ResourceGroupName] [-WhatIf] [-Confirm] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -30,13 +32,13 @@ This command removes the Azure SQL Sync Agent named syncAgent01. ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure ```yaml -Type: SwitchParameter +Type: IAzureContextContainer Parameter Sets: (All) -Aliases: cf +Aliases: AzureRmContext, AzureCredential Required: False Position: Named @@ -120,6 +122,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: 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. @@ -136,6 +153,9 @@ 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 diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlSyncGroup.md b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlSyncGroup.md index 1c14ad4d8b3e..ae7ba2bb5507 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlSyncGroup.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlSyncGroup.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -13,7 +14,8 @@ Removes an Azure SQL Database Sync Group. ``` Remove-AzureRmSqlSyncGroup [-Name] [-Force] [-PassThru] [-ServerName] - [-DatabaseName] [-ResourceGroupName] [-WhatIf] [-Confirm] + [-DatabaseName] [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -30,33 +32,33 @@ This command removes the Azure SQL Database Sync Group named syncGroup01. ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -DatabaseName +The name of the Azure SQL Database. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -DatabaseName -The name of the Azure SQL Database. +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure ```yaml -Type: String +Type: IAzureContextContainer Parameter Sets: (All) -Aliases: +Aliases: AzureRmContext, AzureCredential -Required: True -Position: 2 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -135,6 +137,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: 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. @@ -151,6 +168,9 @@ 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 diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlSyncMember.md b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlSyncMember.md index a016718a9daf..c07cc23505d4 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlSyncMember.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlSyncMember.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -13,7 +14,8 @@ Removes an Azure SQL Database Sync Member. ``` Remove-AzureRmSqlSyncMember -Name [-Force] [-PassThru] [-SyncGroupName] - [-ServerName] [-DatabaseName] [-ResourceGroupName] [-WhatIf] [-Confirm] + [-ServerName] [-DatabaseName] [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -28,36 +30,35 @@ PS C:\>Remove-AzureRmSqlSyncMember -ResourceGroupName "ResourceGroup01" -ServerN This command removes the Azure SQL Database Sync Member named syncMember01. - ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -DatabaseName +The name of the Azure SQL Database. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -DatabaseName -The name of the Azure SQL Database. +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure ```yaml -Type: String +Type: IAzureContextContainer Parameter Sets: (All) -Aliases: +Aliases: AzureRmContext, AzureCredential -Required: True -Position: 2 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -151,6 +152,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: 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. @@ -167,6 +183,9 @@ 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 diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Restore-AzureRmSqlDatabase.md b/src/ResourceManager/Sql/Commands.Sql/help/Restore-AzureRmSqlDatabase.md index 4ea72978acfe..776d18f3e1e5 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Restore-AzureRmSqlDatabase.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Restore-AzureRmSqlDatabase.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 72E0E558-74D7-4A50-A975-FA7D0C0B301E online version: schema: 2.0.0 @@ -17,7 +18,7 @@ Restores a SQL database. Restore-AzureRmSqlDatabase [-FromPointInTimeBackup] -PointInTime -ResourceId -ServerName -TargetDatabaseName [-Edition ] [-ServiceObjectiveName ] [-ElasticPoolName ] [-ResourceGroupName] - [] + [-DefaultProfile ] [] ``` ### FromDeletedDatabaseBackup @@ -25,21 +26,23 @@ Restore-AzureRmSqlDatabase [-FromPointInTimeBackup] -PointInTime -Res Restore-AzureRmSqlDatabase [-FromDeletedDatabaseBackup] [-PointInTime ] -DeletionDate -ResourceId -ServerName -TargetDatabaseName [-Edition ] [-ServiceObjectiveName ] [-ElasticPoolName ] [-ResourceGroupName] - [] + [-DefaultProfile ] [] ``` ### FromGeoBackup ``` Restore-AzureRmSqlDatabase [-FromGeoBackup] -ResourceId -ServerName -TargetDatabaseName [-Edition ] [-ServiceObjectiveName ] - [-ElasticPoolName ] [-ResourceGroupName] [] + [-ElasticPoolName ] [-ResourceGroupName] [-DefaultProfile ] + [] ``` ### FromLongTermRetentionBackup ``` Restore-AzureRmSqlDatabase [-FromLongTermRetentionBackup] -ResourceId -ServerName -TargetDatabaseName [-Edition ] [-ServiceObjectiveName ] - [-ElasticPoolName ] [-ResourceGroupName] [] + [-ElasticPoolName ] [-ResourceGroupName] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -100,6 +103,21 @@ The second command restores the backup in $GeoBackup to the SQL database named R ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DeletionDate Specifies the deletion date as a **DateTime** object. To get a **DateTime** object, use the Get-Date cmdlet. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Resume-AzureRmSqlDatabase.md b/src/ResourceManager/Sql/Commands.Sql/help/Resume-AzureRmSqlDatabase.md index 0e2bc1091a51..08215607215d 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Resume-AzureRmSqlDatabase.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Resume-AzureRmSqlDatabase.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 84CF049A-D293-4FEB-8608-179146EADE41 online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Resumes a SQL Data Warehouse database. ## SYNTAX ``` -Resume-AzureRmSqlDatabase [-ServerName] -DatabaseName [-ResourceGroupName] [-WhatIf] - [-Confirm] [] +Resume-AzureRmSqlDatabase [-ServerName] -DatabaseName [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -46,6 +47,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group to which the database is assigned. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabase.md b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabase.md index 85a4bc76594a..96ba6930627b 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabase.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabase.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 2E4F5C27-C50F-4133-B193-BC477BCD6778 -online version: +online version: schema: 2.0.0 --- @@ -15,8 +16,8 @@ Sets properties for a database, or moves an existing database into an elastic po ``` Set-AzureRmSqlDatabase [-DatabaseName] [-MaxSizeBytes ] [-Edition ] [-RequestedServiceObjectiveName ] [-ElasticPoolName ] [-ReadScale ] - [-Tags ] [-ServerName] [-ResourceGroupName] [-WhatIf] [-Confirm] - [] + [-Tags ] [-ServerName] [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -93,6 +94,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Edition Specifies the edition for the database. The acceptable values for this parameter are: @@ -107,7 +123,7 @@ The acceptable values for this parameter are: ```yaml Type: DatabaseEdition Parameter Sets: (All) -Aliases: +Aliases: Accepted values: None, Premium, Basic, Standard, DataWarehouse, Stretch, Free, PremiumRS Required: False @@ -123,7 +139,7 @@ Specifies name of the elastic pool in which to move the database. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -140,7 +156,7 @@ See the *MaxSizeGB* parameter for acceptable values per edition. ```yaml Type: Int64 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -155,7 +171,7 @@ The read scale option to assign to the Azure SQL Database.(Enabled/Disabled) ```yaml Type: DatabaseReadScale Parameter Sets: (All) -Aliases: +Aliases: Accepted values: Disabled, Enabled Required: False @@ -173,7 +189,7 @@ in the Microsoft Developer Network Library. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -188,7 +204,7 @@ Specifies the name of resource group to which the server is assigned. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -203,7 +219,7 @@ Specifies the name of the server that hosts the database. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseAdvisorAutoExecuteStatus.md b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseAdvisorAutoExecuteStatus.md index f2bdb5d6281a..6062e4ba38b7 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseAdvisorAutoExecuteStatus.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseAdvisorAutoExecuteStatus.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 50E09DF7-F5B5-4668-9520-73D562E91800 online version: schema: 2.0.0 @@ -15,7 +16,8 @@ Modifies auto execute status of an Azure SQL Database Advisor. ``` Set-AzureRmSqlDatabaseAdvisorAutoExecuteStatus -AdvisorName -AutoExecuteStatus -ServerName -DatabaseName - [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -94,6 +96,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group of the server that contains this database. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseAuditing.md b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseAuditing.md index 47fc2fefc4cc..f0bdd49b00bc 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseAuditing.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseAuditing.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: F7EF35E3-BC53-43D9-A71E-0B4316260A08 online version: schema: 2.0.0 @@ -16,7 +17,7 @@ Changes the auditing settings for an Azure SQL database. Set-AzureRmSqlDatabaseAuditing -State [-PassThru] [-AuditActionGroup ] [-AuditAction ] [-StorageAccountName ] [-StorageKeyType ] [-RetentionInDays ] [-ServerName] [-DatabaseName] [-ResourceGroupName] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -67,7 +68,7 @@ The set of the audit action groups Type: AuditActionGroups[] Parameter Sets: (All) Aliases: -Accepted values: BATCH_STARTED_GROUP, BATCH_COMPLETED_GROUP, APPLICATION_ROLE_CHANGE_PASSWORD_GROUP, BACKUP_RESTORE_GROUP, DATABASE_LOGOUT_GROUP, DATABASE_OBJECT_CHANGE_GROUP, DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP, DATABASE_OBJECT_PERMISSION_CHANGE_GROUP, DATABASE_OPERATION_GROUP, DATABASE_PERMISSION_CHANGE_GROUP, DATABASE_PRINCIPAL_CHANGE_GROUP, DATABASE_PRINCIPAL_IMPERSONATION_GROUP, DATABASE_ROLE_MEMBER_CHANGE_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, SCHEMA_OBJECT_ACCESS_GROUP, SCHEMA_OBJECT_CHANGE_GROUP, SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP, SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, USER_CHANGE_PASSWORD_GROUP +Accepted values: BATCH_STARTED_GROUP, BATCH_COMPLETED_GROUP, APPLICATION_ROLE_CHANGE_PASSWORD_GROUP, AUDIT_CHANGE_GROUP, BACKUP_RESTORE_GROUP, DATABASE_LOGOUT_GROUP, DATABASE_OBJECT_CHANGE_GROUP, DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP, DATABASE_OBJECT_PERMISSION_CHANGE_GROUP, DATABASE_OPERATION_GROUP, DATABASE_PERMISSION_CHANGE_GROUP, DATABASE_PRINCIPAL_CHANGE_GROUP, DATABASE_PRINCIPAL_IMPERSONATION_GROUP, DATABASE_ROLE_MEMBER_CHANGE_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, SCHEMA_OBJECT_ACCESS_GROUP, SCHEMA_OBJECT_CHANGE_GROUP, SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP, SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, USER_CHANGE_PASSWORD_GROUP Required: False Position: Named @@ -91,6 +92,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PassThru {{Fill PassThru Description}} diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseAuditingPolicy.md b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseAuditingPolicy.md index 18ce604994c4..0c0c4144de4e 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseAuditingPolicy.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseAuditingPolicy.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: F7EF35E3-BC53-43D9-A71E-0B4316260A08 online version: schema: 2.0.0 @@ -17,7 +18,7 @@ Set-AzureRmSqlDatabaseAuditingPolicy [-AuditType ] [-PassThru] [-AuditActionGroup ] [-AuditAction ] [-EventType ] [-StorageAccountName ] [-StorageKeyType ] [-RetentionInDays ] [-TableIdentifier ] [-ServerName] [-DatabaseName] [-ResourceGroupName] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -91,7 +92,7 @@ This parameter is only applicable to Blob auditing. Type: AuditActionGroups[] Parameter Sets: (All) Aliases: -Accepted values: BATCH_STARTED_GROUP, BATCH_COMPLETED_GROUP, APPLICATION_ROLE_CHANGE_PASSWORD_GROUP, BACKUP_RESTORE_GROUP, DATABASE_LOGOUT_GROUP, DATABASE_OBJECT_CHANGE_GROUP, DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP, DATABASE_OBJECT_PERMISSION_CHANGE_GROUP, DATABASE_OPERATION_GROUP, DATABASE_PERMISSION_CHANGE_GROUP, DATABASE_PRINCIPAL_CHANGE_GROUP, DATABASE_PRINCIPAL_IMPERSONATION_GROUP, DATABASE_ROLE_MEMBER_CHANGE_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, SCHEMA_OBJECT_ACCESS_GROUP, SCHEMA_OBJECT_CHANGE_GROUP, SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP, SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, USER_CHANGE_PASSWORD_GROUP +Accepted values: BATCH_STARTED_GROUP, BATCH_COMPLETED_GROUP, APPLICATION_ROLE_CHANGE_PASSWORD_GROUP, AUDIT_CHANGE_GROUP, BACKUP_RESTORE_GROUP, DATABASE_LOGOUT_GROUP, DATABASE_OBJECT_CHANGE_GROUP, DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP, DATABASE_OBJECT_PERMISSION_CHANGE_GROUP, DATABASE_OPERATION_GROUP, DATABASE_PERMISSION_CHANGE_GROUP, DATABASE_PRINCIPAL_CHANGE_GROUP, DATABASE_PRINCIPAL_IMPERSONATION_GROUP, DATABASE_ROLE_MEMBER_CHANGE_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, SCHEMA_OBJECT_ACCESS_GROUP, SCHEMA_OBJECT_CHANGE_GROUP, SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP, SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, USER_CHANGE_PASSWORD_GROUP Required: False Position: Named @@ -129,6 +130,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EventType Specifies the event types to audit. This parameter is only applicable to Table auditing. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy.md b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy.md index 91755c772304..0a4c1b731946 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 196E1AC9-A1E2-47D2-A3C1-535EFE439EE8 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Sets a server long term retention policy. ``` Set-AzureRmSqlDatabaseBackupLongTermRetentionPolicy -State -ResourceId [-ServerName] - [-DatabaseName] [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-DatabaseName] [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -45,6 +47,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group that contains the database. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseDataMaskingPolicy.md b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseDataMaskingPolicy.md index ec74a0eaf152..29f00e58e445 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseDataMaskingPolicy.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseDataMaskingPolicy.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 1B138185-E836-414F-93CD-7BAE7F474E73 online version: schema: 2.0.0 @@ -15,7 +16,7 @@ Sets data masking for a database. ``` Set-AzureRmSqlDatabaseDataMaskingPolicy [-PassThru] [-PrivilegedLogins ] [-PrivilegedUsers ] [-DataMaskingState ] [-ServerName] [-DatabaseName] [-ResourceGroupName] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -77,6 +78,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PassThru Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseDataMaskingRule.md b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseDataMaskingRule.md index a8e2c40c07e5..276e8bf43c23 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseDataMaskingRule.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseDataMaskingRule.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 48CF206C-AF63-4013-834E-8EC3646D180B online version: schema: 2.0.0 @@ -16,7 +17,8 @@ Sets the properties of a data masking rule for a database. Set-AzureRmSqlDatabaseDataMaskingRule [-MaskingFunction ] [-PrefixSize ] [-ReplacementString ] [-SuffixSize ] [-NumberFrom ] [-NumberTo ] [-PassThru] -SchemaName -TableName -ColumnName [-ServerName] [-DatabaseName] - [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -75,6 +77,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MaskingFunction Specifies the masking function that the rule uses. The acceptable values for this parameter are: diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseFailoverGroup.md b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseFailoverGroup.md index bab51081f243..7dbb077a9b0e 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseFailoverGroup.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseFailoverGroup.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -15,7 +16,7 @@ Modifies the configuration of an Azure SQL Database Failover Group. Set-AzureRmSqlDatabaseFailoverGroup [-ServerName] [-FailoverGroupName] [-FailoverPolicy ] [-GracePeriodWithDataLossHours ] [-AllowReadOnlyFailoverToPrimary ] [-ResourceGroupName] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -61,6 +62,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -FailoverGroupName The name of the Azure SQL Database Failover Group. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseGeoBackupPolicy.md b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseGeoBackupPolicy.md index 6d42fa0d3fbe..5666002a9410 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseGeoBackupPolicy.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseGeoBackupPolicy.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 5A2072B4-1533-46A2-9841-5509A44DE695 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Sets a database geo backup policy. ``` Set-AzureRmSqlDatabaseGeoBackupPolicy -State [-ServerName] - [-DatabaseName] [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-DatabaseName] [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -45,6 +47,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group of the server that contains this database. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseRecommendedActionState.md b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseRecommendedActionState.md index c8eee832d916..64dbffd85528 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseRecommendedActionState.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseRecommendedActionState.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: BDBA3AA3-DCC6-4C83-84C8-EE6D93BFE1D3 online version: schema: 2.0.0 @@ -14,8 +15,8 @@ Updates the state of an Azure SQL Database recommended action. ``` Set-AzureRmSqlDatabaseRecommendedActionState -RecommendedActionName -State - -ServerName -DatabaseName -AdvisorName [-ResourceGroupName] [-WhatIf] - [-Confirm] [] + -ServerName -DatabaseName -AdvisorName [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -93,6 +94,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RecommendedActionName Specifies the name of the recommended action for which state is being updated. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseSecondary.md b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseSecondary.md index 82dbb84c3af8..a2acc19cc889 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseSecondary.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseSecondary.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: F9703508-DD4D-4D25-A7CA-7E3432B5DCA9 online version: schema: 2.0.0 @@ -15,14 +16,15 @@ Switches a secondary database to be primary in order to initiate failover. ### NoOptionsSet (Default) ``` Set-AzureRmSqlDatabaseSecondary [-DatabaseName] -PartnerResourceGroupName - [-ServerName] [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ServerName] [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ### ByFailoverParams ``` Set-AzureRmSqlDatabaseSecondary [-DatabaseName] -PartnerResourceGroupName [-Failover] - [-AllowDataLoss] [-ServerName] [-ResourceGroupName] [-WhatIf] [-Confirm] - [] + [-AllowDataLoss] [-ServerName] [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -71,6 +73,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Failover Indicates that this operation is a failover. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseThreatDetectionPolicy.md b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseThreatDetectionPolicy.md index 57f4f43ebab7..1a04a1d980d6 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseThreatDetectionPolicy.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseThreatDetectionPolicy.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 457FD595-D5E1-45C4-9DB8-C3C6C30A0E94 online version: schema: 2.0.0 @@ -16,7 +17,7 @@ Sets a threat detection policy on a database. Set-AzureRmSqlDatabaseThreatDetectionPolicy [-PassThru] [-NotificationRecipientsEmails ] [-EmailAdmins ] [-ExcludedDetectionType ] [-StorageAccountName ] [-RetentionInDays ] [-ServerName] [-DatabaseName] [-ResourceGroupName] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -53,6 +54,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EmailAdmins Specifies whether the threat detection policy contacts administrators by using email. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseTransparentDataEncryption.md b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseTransparentDataEncryption.md index 3a1f3cbc3110..3fda08269c33 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseTransparentDataEncryption.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlDatabaseTransparentDataEncryption.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 01744DBD-1991-45EF-AA92-FD471F7E7551 online version: schema: 2.0.0 @@ -14,8 +15,8 @@ Modifies TDE property for a database. ``` Set-AzureRmSqlDatabaseTransparentDataEncryption [-State] - [-ServerName] [-DatabaseName] [-ResourceGroupName] [-WhatIf] [-Confirm] - [] + [-ServerName] [-DatabaseName] [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -53,6 +54,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group to which the database is assigned. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlElasticPool.md b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlElasticPool.md index 50b2a8a2f705..e5ecc310163d 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlElasticPool.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlElasticPool.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 555D58AB-1361-4BB1-ACD0-905C3C6F4F7E -online version: +online version: schema: 2.0.0 --- @@ -15,7 +16,8 @@ Modifies properties of an elastic database pool in Azure SQL Database. ``` Set-AzureRmSqlElasticPool [-ElasticPoolName] [-Edition ] [-Dtu ] [-StorageMB ] [-DatabaseDtuMin ] [-DatabaseDtuMax ] [-Tags ] - [-ServerName] [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ServerName] [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -23,7 +25,6 @@ The **Set-AzureRmSqlElasticPool** cmdlet modifies properties for an elastic data Several parameters (*-Dtu, -DatabaseDtuMin, and -DatabaseDtuMax*) require the value being set is from the list of valid values for that parameter. For example, -DatabaseDtuMax for a Standard 100 eDTU pool can only be set to 10, 20, 50, or 100. For details about which values are valid, see the table for your specific size pool in [elastic pools](https://docs.microsoft.com/azure/sql-database/sql-database-elastic-pool). - ## EXAMPLES ### Example 1: Modify properties for an elastic pool @@ -86,7 +87,7 @@ values for different editions are as follows: ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -105,7 +106,22 @@ The default value is zero (0). ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +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: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential Required: False Position: Named @@ -129,7 +145,7 @@ editions are as follows: ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -153,7 +169,7 @@ edition. The acceptable values for this parameter are: ```yaml Type: DatabaseEdition Parameter Sets: (All) -Aliases: +Aliases: Accepted values: None, Premium, Basic, Standard, DataWarehouse, Stretch, Free, PremiumRS Required: False @@ -184,7 +200,7 @@ Specifies the name of the resource group to which the elastic pool is assigned. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -199,7 +215,7 @@ Specifies the name of the server that hosts the elastic pool. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 1 @@ -215,7 +231,7 @@ New-AzureRmSqlElasticPool cmdlet. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlElasticPoolAdvisorAutoExecuteStatus.md b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlElasticPoolAdvisorAutoExecuteStatus.md index 573624ce781d..a10dc1178cfe 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlElasticPoolAdvisorAutoExecuteStatus.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlElasticPoolAdvisorAutoExecuteStatus.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: BAA0781E-DC02-4AAF-A039-9B71B67E6696 online version: schema: 2.0.0 @@ -15,7 +16,8 @@ Updates auto execute status of an Azure SQL Elastic Pool Advisor. ``` Set-AzureRmSqlElasticPoolAdvisorAutoExecuteStatus -AdvisorName -AutoExecuteStatus -ServerName -ElasticPoolName - [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -79,6 +81,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ElasticPoolName Specifies the name of the elastic pool. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlElasticPoolRecommendedActionState.md b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlElasticPoolRecommendedActionState.md index 5a13f252610b..2b1a3babdb9c 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlElasticPoolRecommendedActionState.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlElasticPoolRecommendedActionState.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: EFDFCE12-F39C-4F52-9962-4601F0C4FD47 online version: schema: 2.0.0 @@ -14,8 +15,8 @@ Updates the state of an Azure SQL Elastic Pool recommended action. ``` Set-AzureRmSqlElasticPoolRecommendedActionState -RecommendedActionName -State - -ServerName -ElasticPoolName -AdvisorName [-ResourceGroupName] [-WhatIf] - [-Confirm] [] + -ServerName -ElasticPoolName -AdvisorName [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -77,6 +78,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ElasticPoolName Specifies name of the elastic pool. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServer.md b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServer.md index 31bc13b17062..01e13e9497c0 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServer.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServer.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: FAAF458C-1662-4130-9A16-0514B714D11D -online version: +online version: schema: 2.0.0 --- @@ -14,8 +15,8 @@ Modifies properties of a SQL Database server. ``` Set-AzureRmSqlServer [-ServerName] [-SqlAdministratorPassword ] [-Tags ] - [-ServerVersion ] [-AssignIdentity] [-Force] [-ResourceGroupName] [-WhatIf] [-Confirm] - [] + [-ServerVersion ] [-AssignIdentity] [-Force] [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -47,7 +48,22 @@ Generate and assign an Azure Active Directory Identity for this server for use w ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +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: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential Required: False Position: Named @@ -62,7 +78,7 @@ Forces the command to run without asking for user confirmation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -77,7 +93,7 @@ Specifies the name of the resource group to which the server is assigned. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -108,7 +124,7 @@ parameter are: 2.0 and 12.0. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -125,7 +141,7 @@ ConvertTo-SecureString`. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerActiveDirectoryAdministrator.md b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerActiveDirectoryAdministrator.md index 90c732de8126..d63a369e6d03 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerActiveDirectoryAdministrator.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerActiveDirectoryAdministrator.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 60E0D10F-9B93-45A9-A1FF-5C943B8CA09C online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Provisions an Azure AD administrator for SQL Server. ``` Set-AzureRmSqlServerActiveDirectoryAdministrator [-DisplayName] [[-ObjectId] ] - [-ServerName] [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ServerName] [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -71,6 +73,21 @@ This makes sure that that the command succeeds even if the display name of the g ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DisplayName Specifies the display name of the Azure AD administrator that this cmdlet provisions. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerAdvisorAutoExecuteStatus.md b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerAdvisorAutoExecuteStatus.md index 32a939e4a958..853ca4764168 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerAdvisorAutoExecuteStatus.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerAdvisorAutoExecuteStatus.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 6006D3AC-48E1-44A0-8BD5-CE996B8957A2 online version: schema: 2.0.0 @@ -14,8 +15,8 @@ Updates the auto execute status of an Azure SQL Server Advisor. ``` Set-AzureRmSqlServerAdvisorAutoExecuteStatus -AdvisorName - -AutoExecuteStatus -ServerName [-ResourceGroupName] [-WhatIf] - [-Confirm] [] + -AutoExecuteStatus -ServerName [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -78,6 +79,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group of the server. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerAuditing.md b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerAuditing.md index fc61d031cb8c..964a52a6a62c 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerAuditing.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerAuditing.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 14814BF3-51AF-4E51-A8A6-661825BD88D1 online version: schema: 2.0.0 @@ -15,7 +16,8 @@ Changes the auditing settings of an Azure SQL server. ``` Set-AzureRmSqlServerAuditing -State [-AuditActionGroup ] [-PassThru] [-StorageAccountName ] [-StorageKeyType ] [-RetentionInDays ] [-ServerName] - [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -51,7 +53,7 @@ The set of the audit action groups Type: AuditActionGroups[] Parameter Sets: (All) Aliases: -Accepted values: BATCH_STARTED_GROUP, BATCH_COMPLETED_GROUP, APPLICATION_ROLE_CHANGE_PASSWORD_GROUP, BACKUP_RESTORE_GROUP, DATABASE_LOGOUT_GROUP, DATABASE_OBJECT_CHANGE_GROUP, DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP, DATABASE_OBJECT_PERMISSION_CHANGE_GROUP, DATABASE_OPERATION_GROUP, DATABASE_PERMISSION_CHANGE_GROUP, DATABASE_PRINCIPAL_CHANGE_GROUP, DATABASE_PRINCIPAL_IMPERSONATION_GROUP, DATABASE_ROLE_MEMBER_CHANGE_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, SCHEMA_OBJECT_ACCESS_GROUP, SCHEMA_OBJECT_CHANGE_GROUP, SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP, SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, USER_CHANGE_PASSWORD_GROUP +Accepted values: BATCH_STARTED_GROUP, BATCH_COMPLETED_GROUP, APPLICATION_ROLE_CHANGE_PASSWORD_GROUP, AUDIT_CHANGE_GROUP, BACKUP_RESTORE_GROUP, DATABASE_LOGOUT_GROUP, DATABASE_OBJECT_CHANGE_GROUP, DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP, DATABASE_OBJECT_PERMISSION_CHANGE_GROUP, DATABASE_OPERATION_GROUP, DATABASE_PERMISSION_CHANGE_GROUP, DATABASE_PRINCIPAL_CHANGE_GROUP, DATABASE_PRINCIPAL_IMPERSONATION_GROUP, DATABASE_ROLE_MEMBER_CHANGE_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, SCHEMA_OBJECT_ACCESS_GROUP, SCHEMA_OBJECT_CHANGE_GROUP, SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP, SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, USER_CHANGE_PASSWORD_GROUP Required: False Position: Named @@ -60,6 +62,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PassThru {{Fill PassThru Description}} diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerAuditingPolicy.md b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerAuditingPolicy.md index 17b6c804ed88..c377b3d3dee2 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerAuditingPolicy.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerAuditingPolicy.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 4FCC7D8B-A46E-4E5B-8BE2-F62B3D3E715D online version: schema: 2.0.0 @@ -16,7 +17,7 @@ Changes the auditing policy of a SQL Database server. Set-AzureRmSqlServerAuditingPolicy [-AuditType ] [-AuditActionGroup ] [-PassThru] [-EventType ] [-StorageAccountName ] [-StorageKeyType ] [-RetentionInDays ] [-TableIdentifier ] -ServerName [-ResourceGroupName] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -69,7 +70,7 @@ This parameter is only applicable to Blob auditing. Type: AuditActionGroups[] Parameter Sets: (All) Aliases: -Accepted values: BATCH_STARTED_GROUP, BATCH_COMPLETED_GROUP, APPLICATION_ROLE_CHANGE_PASSWORD_GROUP, BACKUP_RESTORE_GROUP, DATABASE_LOGOUT_GROUP, DATABASE_OBJECT_CHANGE_GROUP, DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP, DATABASE_OBJECT_PERMISSION_CHANGE_GROUP, DATABASE_OPERATION_GROUP, DATABASE_PERMISSION_CHANGE_GROUP, DATABASE_PRINCIPAL_CHANGE_GROUP, DATABASE_PRINCIPAL_IMPERSONATION_GROUP, DATABASE_ROLE_MEMBER_CHANGE_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, SCHEMA_OBJECT_ACCESS_GROUP, SCHEMA_OBJECT_CHANGE_GROUP, SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP, SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, USER_CHANGE_PASSWORD_GROUP +Accepted values: BATCH_STARTED_GROUP, BATCH_COMPLETED_GROUP, APPLICATION_ROLE_CHANGE_PASSWORD_GROUP, AUDIT_CHANGE_GROUP, BACKUP_RESTORE_GROUP, DATABASE_LOGOUT_GROUP, DATABASE_OBJECT_CHANGE_GROUP, DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP, DATABASE_OBJECT_PERMISSION_CHANGE_GROUP, DATABASE_OPERATION_GROUP, DATABASE_PERMISSION_CHANGE_GROUP, DATABASE_PRINCIPAL_CHANGE_GROUP, DATABASE_PRINCIPAL_IMPERSONATION_GROUP, DATABASE_ROLE_MEMBER_CHANGE_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP, SCHEMA_OBJECT_ACCESS_GROUP, SCHEMA_OBJECT_CHANGE_GROUP, SCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP, SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, USER_CHANGE_PASSWORD_GROUP Required: False Position: Named @@ -94,6 +95,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EventType Specifies the event types to audit. This parameter is only applicable to Table auditing. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerBackupLongTermRetentionVault.md b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerBackupLongTermRetentionVault.md index 26d4609da26f..7a5cb5834c5c 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerBackupLongTermRetentionVault.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerBackupLongTermRetentionVault.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 7642F18A-B193-4849-BE3C-1B85FBD213F3 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Sets a server long term retention vault. ``` Set-AzureRmSqlServerBackupLongTermRetentionVault -ResourceId [-ServerName] - [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -30,6 +32,21 @@ The vault is an Azure Backup resource used to store backup data. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group that contains the server. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerDisasterRecoveryConfiguration.md b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerDisasterRecoveryConfiguration.md index e20080fc1233..884a1e0a9624 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerDisasterRecoveryConfiguration.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerDisasterRecoveryConfiguration.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 44F8EFF4-8E3D-4657-9D17-2A3F49CEA515 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Modifies a database server recovery configuration. ``` Set-AzureRmSqlServerDisasterRecoveryConfiguration -VirtualEndpointName [-Failover] [-AllowDataLoss] - [-ServerName] [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ServerName] [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -44,6 +46,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Failover Indicates that this operation is a failover. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerFirewallRule.md b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerFirewallRule.md index e3688ed22a8a..c9519213ccc2 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerFirewallRule.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerFirewallRule.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: B407CF77-792B-40F8-87AB-49FB3DCEE646 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Modifies a firewall rule in Azure SQL Database server. ``` Set-AzureRmSqlServerFirewallRule [-FirewallRuleName] -StartIpAddress -EndIpAddress - [-ServerName] [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ServerName] [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -37,6 +39,21 @@ The command modifies the start and end IP addresses. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EndIpAddress Specifies the end value of the IP address range for this rule. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerRecommendedActionState.md b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerRecommendedActionState.md index fc686a2baa18..646eedecc78d 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerRecommendedActionState.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerRecommendedActionState.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 26EC220C-5123-4CEF-8CC6-5FFD08F33481 online version: schema: 2.0.0 @@ -14,8 +15,8 @@ Updates the state of an Azure SQL Server recommended action. ``` Set-AzureRmSqlServerRecommendedActionState -RecommendedActionName -State - -ServerName -AdvisorName [-ResourceGroupName] [-WhatIf] [-Confirm] - [] + -ServerName -AdvisorName [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -76,6 +77,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RecommendedActionName Specifies the name of the recommended action for which this cmdlet updates the state. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerThreatDetectionPolicy.md b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerThreatDetectionPolicy.md index 3814a4e34746..971dbe564637 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerThreatDetectionPolicy.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerThreatDetectionPolicy.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 2B82F5BA-ABC6-4B37-B641-353CFE814290 online version: schema: 2.0.0 @@ -15,8 +16,8 @@ Sets a threat detection policy on a server. ``` Set-AzureRmSqlServerThreatDetectionPolicy [-PassThru] [-NotificationRecipientsEmails ] [-EmailAdmins ] [-ExcludedDetectionType ] [-StorageAccountName ] - [-RetentionInDays ] -ServerName [-ResourceGroupName] [-WhatIf] [-Confirm] - [] + [-RetentionInDays ] -ServerName [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -35,6 +36,21 @@ This command sets the threat detection policy for a server named Server01. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EmailAdmins Specifies whether the threat detection policy contacts administrators by using email. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerTransparentDataEncryptionProtector.md b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerTransparentDataEncryptionProtector.md index 68e1e7c4541b..6784578cc45d 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerTransparentDataEncryptionProtector.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerTransparentDataEncryptionProtector.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -13,7 +14,8 @@ Sets the Transparent Data Encryption (TDE) protector for a SQL server. ``` Set-AzureRmSqlServerTransparentDataEncryptionProtector [-Type] [[-KeyId] ] - [-Force] [-ServerName] [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-Force] [-ServerName] [-ResourceGroupName] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -46,6 +48,21 @@ ContosoResourceGroup ContosoServer AzureKeyVault contoso_contosokey_012345678901 ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Skip confirmation message for performing the action diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerVirtualNetworkRule.md b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerVirtualNetworkRule.md index a64da549d434..0d5090368670 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerVirtualNetworkRule.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Set-AzureRmSqlServerVirtualNetworkRule.md @@ -16,6 +16,7 @@ Modifies the configuration of an Azure SQL Server Virtual Network Rule. Set-AzureRmSqlServerVirtualNetworkRule -VirtualNetworkRuleName -VirtualNetworkSubnetId [-IgnoreMissingVnetServiceEndpoint] -ServerName [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] [] + ``` ## DESCRIPTION @@ -36,7 +37,7 @@ Modifies an existing virtual network rule with the new virtual network subnet id ## PARAMETERS ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with azure. +The credentials, account, tenant, and subscription used for communication with azure ```yaml Type: IAzureContextContainer diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Start-AzureRmSqlDatabaseExecuteIndexRecommendation.md b/src/ResourceManager/Sql/Commands.Sql/help/Start-AzureRmSqlDatabaseExecuteIndexRecommendation.md index 2452c49af8f9..a57457a27570 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Start-AzureRmSqlDatabaseExecuteIndexRecommendation.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Start-AzureRmSqlDatabaseExecuteIndexRecommendation.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 0EA0B131-A3D0-43CA-8517-9E724A11B04F online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Starts the workflow that runs a recommended index operation. ``` Start-AzureRmSqlDatabaseExecuteIndexRecommendation -ServerName -DatabaseName - -IndexRecommendationName [-ResourceGroupName] [] + -IndexRecommendationName [-ResourceGroupName] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -46,6 +48,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IndexRecommendationName Specifies the name of the index recommendation that this cmdlet runs. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Start-AzureRmSqlServerUpgrade.md b/src/ResourceManager/Sql/Commands.Sql/help/Start-AzureRmSqlServerUpgrade.md index 26a2ab0098b0..363af2d62adb 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Start-AzureRmSqlServerUpgrade.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Start-AzureRmSqlServerUpgrade.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 69A26BF3-7FE7-41ED-8C21-C8DC72D09615 online version: schema: 2.0.0 @@ -16,7 +17,7 @@ Starts the upgrade of a SQL Database server. Start-AzureRmSqlServerUpgrade -ServerVersion [-ScheduleUpgradeAfterUtcDateTime ] [-DatabaseCollection ] [-ElasticPoolCollection ] -ServerName - [-ResourceGroupName] [] + [-ResourceGroupName] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -76,6 +77,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ElasticPoolCollection Specifies an array of **UpgradeRecommendedElasticPoolProperties** objects to use for the server upgrade. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Start-AzureRmSqlSyncGroupSync.md b/src/ResourceManager/Sql/Commands.Sql/help/Start-AzureRmSqlSyncGroupSync.md index 3886b5837b4a..98d0e5c85b0e 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Start-AzureRmSqlSyncGroupSync.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Start-AzureRmSqlSyncGroupSync.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -13,7 +14,8 @@ Starts a sync group synchronization. ``` Start-AzureRmSqlSyncGroupSync [-SyncGroupName] [-PassThru] [-ServerName] - [-DatabaseName] [-ResourceGroupName] [-WhatIf] [-Confirm] + [-DatabaseName] [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -30,33 +32,33 @@ This command starts a round of synchronization for the sync group mysg. ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -DatabaseName +The name of the Azure SQL Database. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -DatabaseName -The name of the Azure SQL Database. +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure ```yaml -Type: String +Type: IAzureContextContainer Parameter Sets: (All) -Aliases: +Aliases: AzureRmContext, AzureCredential -Required: True -Position: 2 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -120,6 +122,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: 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. @@ -136,6 +153,9 @@ 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 diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Stop-AzureRmSqlDatabaseExecuteIndexRecommendation.md b/src/ResourceManager/Sql/Commands.Sql/help/Stop-AzureRmSqlDatabaseExecuteIndexRecommendation.md index 745f6d089ab8..1ea88a0a14d9 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Stop-AzureRmSqlDatabaseExecuteIndexRecommendation.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Stop-AzureRmSqlDatabaseExecuteIndexRecommendation.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 4D2E0956-FBFA-43CC-ABE3-A6CBB9409263 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Stops the workflow that runs a recommended index operation. ``` Stop-AzureRmSqlDatabaseExecuteIndexRecommendation -ServerName -DatabaseName - -IndexRecommendationName [-ResourceGroupName] [] + -IndexRecommendationName [-ResourceGroupName] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -46,6 +48,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IndexRecommendationName Specifies the name of the index recommendation that this cmdlet stops. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Stop-AzureRmSqlServerUpgrade.md b/src/ResourceManager/Sql/Commands.Sql/help/Stop-AzureRmSqlServerUpgrade.md index c1f5936b986a..17c00661c20a 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Stop-AzureRmSqlServerUpgrade.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Stop-AzureRmSqlServerUpgrade.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 972F4188-52C5-4B92-8B88-E68526537F48 online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Stops the upgrade of a SQL Database server. ## SYNTAX ``` -Stop-AzureRmSqlServerUpgrade [-Force] -ServerName [-ResourceGroupName] [-WhatIf] [-Confirm] - [] +Stop-AzureRmSqlServerUpgrade [-Force] -ServerName [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -31,6 +32,21 @@ This command stops the request to upgrade the server named Server02 assigned to ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Stop-AzureRmSqlSyncGroupSync.md b/src/ResourceManager/Sql/Commands.Sql/help/Stop-AzureRmSqlSyncGroupSync.md index b095267964b6..b3460c452e35 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Stop-AzureRmSqlSyncGroupSync.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Stop-AzureRmSqlSyncGroupSync.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -13,7 +14,8 @@ Stops a sync group synchronization. ``` Stop-AzureRmSqlSyncGroupSync [-SyncGroupName] [-PassThru] [-ServerName] - [-DatabaseName] [-ResourceGroupName] [-WhatIf] [-Confirm] + [-DatabaseName] [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -30,33 +32,33 @@ This command stops the synchronization which is ongoing for the sync group mysg. ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -DatabaseName +The name of the Azure SQL Database. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -DatabaseName -The name of the Azure SQL Database. +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure ```yaml -Type: String +Type: IAzureContextContainer Parameter Sets: (All) -Aliases: +Aliases: AzureRmContext, AzureCredential -Required: True -Position: 2 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -120,6 +122,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: 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. @@ -136,6 +153,9 @@ 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 diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Suspend-AzureRmSqlDatabase.md b/src/ResourceManager/Sql/Commands.Sql/help/Suspend-AzureRmSqlDatabase.md index e1a8638f76e9..b2e804cf98c4 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Suspend-AzureRmSqlDatabase.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Suspend-AzureRmSqlDatabase.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 7302D785-9DD0-4CC0-93C9-9A6EA60591CF online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Suspends a SQL Data Warehouse database. ``` Suspend-AzureRmSqlDatabase [-ServerName] -DatabaseName [-ResourceGroupName] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -46,6 +47,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group to which the server is assigned. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Switch-AzureRmSqlDatabaseFailoverGroup.md b/src/ResourceManager/Sql/Commands.Sql/help/Switch-AzureRmSqlDatabaseFailoverGroup.md index fa69cb67d63e..1e6d254becfd 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Switch-AzureRmSqlDatabaseFailoverGroup.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Switch-AzureRmSqlDatabaseFailoverGroup.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -13,7 +14,8 @@ Executes a failover of an Azure SQL Database Failover Group. ``` Switch-AzureRmSqlDatabaseFailoverGroup [-ServerName] [[-FailoverGroupName] ] [-AllowDataLoss] - [-ResourceGroupName] [-WhatIf] [-Confirm] [] + [-ResourceGroupName] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -54,6 +56,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -FailoverGroupName The name of the Azure SQL Database Failover Group. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Update-AzureRmSqlSyncGroup.md b/src/ResourceManager/Sql/Commands.Sql/help/Update-AzureRmSqlSyncGroup.md index 3a9dcd2689a3..2c1c3bc31b1d 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Update-AzureRmSqlSyncGroup.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Update-AzureRmSqlSyncGroup.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -13,14 +14,13 @@ Updates an Azure SQL Database Sync Group. ``` Update-AzureRmSqlSyncGroup [-Name] [-IntervalInSeconds ] [-DatabaseCredential ] - [-SchemaFile ] [-ServerName] [-DatabaseName] [-ResourceGroupName] [-WhatIf] - [-Confirm] + [-SchemaFile ] [-ServerName] [-DatabaseName] [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION The **Update-AzureRmSqlSyncGroup** cmdlet modifies properties of an Azure SQL Database Sync Group. - ## EXAMPLES ### Example 1: Update a sync group for an Azure SQL Database. @@ -40,7 +40,7 @@ HubDatabaseUserName : myAccount HubDatabasePassword : SyncState : NotReady LastSyncTime : 1/1/0001 12:00:00 AM -Schema : +Schema : ``` This command updates a sync group for an Azure SQL Database. "schema.json" is a file in the local disk. It contains the shema payload in json format. An example of the schema json is: @@ -51,21 +51,6 @@ This command updates a sync group for an Azure SQL Database. "schema.json" is a ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -DatabaseCredential The SQL authentication credential of the hub database. @@ -96,6 +81,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IntervalInSeconds The frequency (in seconds) of doing data synchronization. Default is -1, which means the auto synchronization is not enabled. @@ -172,6 +172,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: 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. @@ -188,6 +203,9 @@ 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 diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Update-AzureRmSqlSyncMember.md b/src/ResourceManager/Sql/Commands.Sql/help/Update-AzureRmSqlSyncMember.md index e63d86e1b46d..21522f0e233d 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Update-AzureRmSqlSyncMember.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Update-AzureRmSqlSyncMember.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -13,7 +14,8 @@ Updates an Azure SQL Database Sync Member. ``` Update-AzureRmSqlSyncMember -Name -MemberDatabaseCredential [-SyncGroupName] - [-ServerName] [-DatabaseName] [-ResourceGroupName] [-WhatIf] [-Confirm] + [-ServerName] [-DatabaseName] [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -40,40 +42,40 @@ MemberServerName : memberServer01.full.dns.name MemberDatabaseName : memberDatabase01 MemberDatabaseUserName : myAccount-new MemberDatabasePassword : -SyncState : Good +SyncState : Good ``` This command resets the administrator password for the member database. ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -DatabaseName +The name of the Azure SQL Database. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -DatabaseName -The name of the Azure SQL Database. +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure ```yaml -Type: String +Type: IAzureContextContainer Parameter Sets: (All) -Aliases: +Aliases: AzureRmContext, AzureCredential -Required: True -Position: 2 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -152,6 +154,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: 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. @@ -168,6 +185,9 @@ 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 diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Update-AzureRmSqlSyncSchema.md b/src/ResourceManager/Sql/Commands.Sql/help/Update-AzureRmSqlSyncSchema.md index e5724c25fed5..17b553a2b2ae 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Update-AzureRmSqlSyncSchema.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Update-AzureRmSqlSyncSchema.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -15,7 +16,8 @@ If "SyncMemberName" is specified, it will refresh the member database schema; if ``` Update-AzureRmSqlSyncSchema [-SyncGroupName] [-SyncMemberName ] [-PassThru] - [-ServerName] [-DatabaseName] [-ResourceGroupName] [-WhatIf] [-Confirm] + [-ServerName] [-DatabaseName] [-ResourceGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -30,7 +32,6 @@ PS C:\>Update-AzureRmSqlSyncSchema -ResourceGroupName "ResourceGroup01" -ServerN This command updates the sync schema for the hub database in the sync group syncGroup01 - ### Example 2: Update the sync schema for a member database ``` PS C:\>Update-AzureRmSqlSyncSchema -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "database01" -SyncGroupName "syncGroup01" -SyncMemberName "syncMember01" @@ -40,33 +41,33 @@ This command updates the sync schema for the member database in the sync member ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -DatabaseName +The name of the Azure SQL Database. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -DatabaseName -The name of the Azure SQL Database. +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure ```yaml -Type: String +Type: IAzureContextContainer Parameter Sets: (All) -Aliases: +Aliases: AzureRmContext, AzureCredential -Required: True -Position: 2 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -145,6 +146,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: 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. @@ -161,6 +177,9 @@ 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 diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Use-AzureRmSqlServerAuditingPolicy.md b/src/ResourceManager/Sql/Commands.Sql/help/Use-AzureRmSqlServerAuditingPolicy.md index a80bb2aa4659..fc1f422046ac 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Use-AzureRmSqlServerAuditingPolicy.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Use-AzureRmSqlServerAuditingPolicy.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql ms.assetid: 381F5B34-983C-4733-B384-35D6579B79A2 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Specifies that a database uses the auditing policy of its host server. ``` Use-AzureRmSqlServerAuditingPolicy [-PassThru] [-ServerName] [-DatabaseName] - [-ResourceGroupName] [] + [-ResourceGroupName] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -50,6 +51,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PassThru Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.